Show Menu

Beneficiary User Payment Methods

Beneficiary User Payment Methods

Choose the payment method for a User.

post/API/v4/Payment/GetUserPaymentMethods

Header Parameters

Authorizationstring

bearer access_token

Content-typestring

application/json

Request Parameters

No request parameters

Reponse Parameters

PaymentMethodsstring

Returned if successful List of payment methods found. For each payment methods, the following parameters are returned:
PaymentMethodId—Unique Payment method ID
PaymentMethodName—Payment method name

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/Payment/GetUserPaymentMethods 

    {
    }

Sample Response:


{
	"GetUserPaymentMethodsResponse": {
		"UserPaymentMethodResult": {
			"UserPaymentMethods": {
				"UserPaymentMethodDetails": [
					{
						"UserPaymentMethodId": "XTR94500",
						"UserPaymentMethodName": "Bank"
					},
					{
						"UserPaymentMethodId": "XTR94503",
						"UserPaymentMethodName": "Prepaid Virtual Debit Card"
					},
					{
						"UserPaymentMethodId": "XTR94501",
						"UserPaymentMethodName": "PayPal"
					}
				]
			},
			"OperationStatus": {
				"Success": true,
				"Errors": null
			}
		}
	}
}

Why

Products

Developers

How It Works

Resources

Payment and foreign exchange transactions are powered and provided by Corpay. “Corpay” is the marketing trade name for the International Payment Solutions and Risk Management Solutions provided by certain subsidiaries of FleetCor Technologies, Inc. Use of this service is governed by Corpay’s Terms and Conditions.

➤