Show Menu

Beneficiary Company Payment Methods

Beneficiary Company Payment Methods

A Beneficiary Company can transfer to end points Bank from their XTRM 'AnyPay™' digital wallet.

post/API/v4/Payment/GetBeneficiaryCompanyPaymentMethods

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:
BeneficiaryCompanyPaymentMethodId—Unique Payment method ID
BeneficiaryCompanyPaymentMethodName—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/GetBeneficiaryCompanyPaymentMethods

    {
    }
						

Sample Response:


{
	"GetBeneficiaryCompanyPaymentMethodsResponse": {
		"BeneficiaryCompanyPaymentMethodResult": {
			"BeneficiaryCompanyPaymentMethods": {
				"BeneficiaryCompanyPaymentMethodDetails": [
					{
						"BeneficiaryCompanyPaymentMethodId": "XTR94500",
						"BeneficiaryCompanyPaymentMethodName": "Bank"
					}
				]
			},
			"OperationStatus": {
				"Success": true,
				"Errors": null
			}
		}
	}
}