Show Menu

XTRM Pay - Card Processing

Transfer fund from user to company using credit card

This allows you to receive fund from a beneficiary user using their Credit Card. It is a two step process. Fund is deposited in user account followed by sending the deposited fund to the company wallet.

post/API/V4/Fund/TransferFundUsertoCompanyUsingCC

Header Parameters

Authorizationstring

bearer access_token

Content-typestring

application/json

Request Parameters

IssuerAccountNumberstring

String length: inclusive between 1 and 25

UserIDstring

String length: inclusive between 1 and 25. Unuque ID(PATXXX) of the beneficiary user funding the beneficiary company or the remitter.

UserWalletIDint

Integer length: inclusive between 1 and 10. Use 'GetUserWallets' to get WalletID of the user.

CompanyAccountNumberstring

String length: inclusive between 1 and 25

CompanyWalletIDint

Integer length: inclusive between 1 and 10. Use 'GetCompanyWallets' to get WalletID of the company.

Amountdecimal

String length: inclusive between 1 and 25

CurrencyCodestring

String length:3

Descriptionstring

String length: inclusive between 1 and 300

FirstNamestring

String length: inclusive between 1 and 50

LastNamestring

String length: inclusive between 1 and 40

Address1string

String length: inclusive between 1 and 200

Citystring

String length: inclusive between 1 and 25

Statestring

String length: inclusive between 1 and 25

CountryISO2string

String length: 2

PostalCodeint

String length: inclusive between 1 and 15

ExpireMonthint

int length: 2

ExpireYearint

int length: 4

CreditCardNumberint

int length: inclusive between 13 and 16

CreditCardTypestring

String length: inclusive between 1 and 25. Value could be one of these "Visa Card", "Master Card" or "Amex Card"

CVVint

int length: 4

Reponse Parameters

TransactionDetailstring

Returned if successful List of Transaction detail found. For each transaction detail the following parameters are allowed: TransactionID—Unique ID of this transaction Amount—Amount processed Fee—Fee charged Total Amount—Total Amount including fee processed
PaymentStatus—Status of payment

OperationStatusstring

Always returned Indicates the status of the operation. Allowed parameters are:
Errors - Displays an error message if the Property name Obligation Definition/value operation was unsuccessful. For more information, see API Error Message Appendix.
Success—Indicates whether the operation was successful. Returns True if the action was successful or False if it was not successful.

Sample Request:

sandbox.xapi.xtrm.com/API/v4/Fund/TransferFundUsertoCompanyUsingCC

{
  "TransferFundUsertoCompanyUsingCC": {
    "Request": {
      "PaymentDetails": {
        "IssuerAccountNumber": "SPN Issuer Account Number",
        "UserID":"PAT Issuer Account Number",
        "UserWalletID":"User Wallet ID",
        "CompanyAccountNumber":"SPN Issuer Account Number",
        "CompanyWalletID":"Company Wallet ID",
        "Amount": "Amount",
        "CurrencyCode": "Currency Code",
        "Description":"Description of the funding"
      },
      "PayerInformation": {
        "FirstName": "First Name",
        "LastName": "Last Name"
      },
      "PayerBillingAddress":{
       "Address1":"Address 1",
       "City":"City",
       "State":"State",
       "CountryISO2":"Country Code",
       "PostalCode":"Postal Code"
      },
      "CreditCardDetails":{
       "ExpireMonth":"Expire Month",
       "ExpireYear":"Expire Year",
       "CreditCardNumber":"Credit Card Number",
       "CreditCardType":"Visa Card/Master Card",
       "CVV":"CVV"
      }
       
      }
    }
  }
						

Sample Response:


{
	"TransferFundUsertoCompanyUsingCCResponse": {
		"TransferFundUsertoCompanyUsingCCResult": {
			"TransactionID": "15663",
			"Amount": "$100.00 USD",
			"Fee": "$3.00 USD",
			"TotalAmount": "$103.00 USD",
			"OperationStatus": {
				"Success": true,
				"Errors": null
			}
		}
	}
}