API reference

Payment methods

These endpoints list the payment methods available in Xtrm. Each method has an ID, such as XTR94500 for Bank, and a display name. In a batch payment, you set each item's method in SendMethodId, and the method decides which Destination fields the item needs.

There are three lists. GetPaymentMethods lists the seven send methods a batch accepts: take every SendMethodId from it. GetUserPaymentMethods and GetBeneficiaryCompanyPaymentMethods list the ways an individual recipient and a business recipient can move their own money out of their Xtrm wallet, and say which IDs UserWithdrawFund and BeneficiaryCompanyWithdrawFund accept in PaymentMethodID. They aren't lists of batch send methods. You can pay to the recipient's Xtrm wallet (recommended), where the recipient chooses how to transfer the money out of Xtrm. Or you can make a pass-through payment straight to a destination such as a bank account, gift card or prepaid debit card.

All three calls take no parameters, need a POST with an empty JSON object {} as the request body and return the same list for every account. A GET returns HTTP 404.

#List payment methods for paying recipients

POST/API/v4/Payment/GetPaymentMethods

Returns the send methods you can use to pay a recipient in a batch payment. You can pay to the recipient's Xtrm wallet (recommended), where the recipient chooses how to transfer the money out of Xtrm. Or you can make a pass-through payment straight to a destination such as a bank account, gift card or prepaid debit card.

Each method has an ID, such as XTR94500, and a display name, such as Bank. Take each batch item's SendMethodId from this list: a batch accepts exactly these seven IDs, in capitals, and rejects any other value when you submit it. XTR94500 (Bank) is a bank transfer, XTR94502 (AnyPay Individual) and XTR94504 (AnyPay Company) pay a wallet, XTR94503 (Prepaid Virtual Debit Card) and XTR94505 (Digital Gift Cards) pay a card by email, XTR94507 (Bank Check) is a mailed check, and XTR94508 (Rapid Transfer) is a push-to-card payment.

The request takes no parameters.

Note

Send a POST with an empty JSON object {} as the request body. A GET returns HTTP 404 with {"StatusCode": 404, "Message": "The requested resource is not found"}.

Response fields

  • GetPaymentMethodsResponseobject

    Root wrapper for the response.

    Child parameters1
    • PaymentMethodResultobject

      The result of the call.

      Child parameters2
      • PaymentMethodsobject

        The payment methods you can pay with.

        Child parameters1
        • PaymentMethodDetailsobject[]

          One entry per available payment method.

          Child parameters2
          • PaymentMethodIdstring

            The payment method's internal ID, for example XTR94500.

          • PaymentMethodNamestring

            The payment method's display name, for example Bank.

      • OperationStatusobject

        The outcome of the call.

        Child parameters2
        • Successboolean

          Whether the operation succeeded (true) or failed (false).

        • Errorsstring[]

          The error messages when the call fails, as an array of strings. null on success, so decide with Success and use Errors only to explain a failure.

Related: Create a batch payment · List payment methods for individual recipients · List payment methods for business recipients

#List payment methods for individual recipients

POST/API/v4/Payment/GetUserPaymentMethods

Returns the ways an individual recipient can move their own money: XTR94500 (Bank), XTR94502 (AnyPay Individual), XTR94503 (Prepaid Virtual Debit Card), XTR94505 (Digital Gift Cards), XTR94506 (Reward Link) and XTR94508 (Rapid Transfer). The list is the same for every recipient. It isn't the list of batch send methods: take each batch item's SendMethodId from GetPaymentMethods. This list includes XTR94506, which a batch rejects, and leaves out XTR94504 and XTR94507.

UserWithdrawFund transfers money out of an individual recipient's Xtrm wallet and accepts four of these IDs in PaymentMethodID: XTR94500 (bank account), XTR94503 (prepaid card), XTR94505 (digital gift card) and XTR94508 (Rapid Transfer, USD only). Send the ID in capitals, exactly as shown. XTR94502 is the method you use to pay an individual recipient's Xtrm wallet in a batch payment, and XTR94506 (Reward Link) is a reward card that recipients choose in the Xtrm web app. UserWithdrawFund accepts neither, and any other ID fails with <ID> - Invalid Payment Method Id.

The request takes no parameters.

Note

Send a POST with an empty JSON object {} as the request body. A GET returns HTTP 404 with {"StatusCode": 404, "Message": "The requested resource is not found"}.

Response fields

  • GetUserPaymentMethodsResponseobject

    Root wrapper for the response.

    Child parameters1
    • UserPaymentMethodResultobject

      The result of the call.

      Child parameters2
      • UserPaymentMethodsobject

        The payment methods available to the individual recipient.

        Child parameters1
        • UserPaymentMethodDetailsobject[]

          One entry per available payment method.

          Child parameters2
          • UserPaymentMethodIdstring

            The internal ID of a payment method available to the individual recipient, for example XTR94502.

          • UserPaymentMethodNamestring

            A readable name for the payment method, for example AnyPay Individual.

      • OperationStatusobject

        The outcome of the call.

        Child parameters2
        • Successboolean

          Whether the operation succeeded (true) or failed (false).

        • Errorsstring[]

          The error messages when the call fails, as an array of strings. null on success, so decide with Success and use Errors only to explain a failure.

Related: Transfer from an individual recipient's wallet · List a recipient's linked bank accounts · List digital gift cards · List prepaid cards · List payment methods for paying recipients

#List payment methods for business recipients

POST/API/v4/Payment/GetBeneficiaryCompanyPaymentMethods

Returns the ways a business recipient can move its own money out of its Xtrm wallet: to its bank account or its card. It isn't the list of batch send methods: take each batch item's SendMethodId from GetPaymentMethods.

Each method has an ID, such as XTR94500, and a display name, such as Bank. BeneficiaryCompanyWithdrawFund takes either ID in PaymentMethodID: XTR94500 (Bank) or XTR94508 (Rapid Transfer, USD only).

The request takes no parameters.

Note

Send a POST with an empty JSON object {} as the request body. A GET returns HTTP 404 with {"StatusCode": 404, "Message": "The requested resource is not found"}.

Response fields

  • GetBeneficiaryCompanyPaymentMethodsResponseobject

    Root wrapper for the response.

    Child parameters1
    • BeneficiaryCompanyPaymentMethodResultobject

      The result of the call.

      Child parameters2
      • BeneficiaryCompanyPaymentMethodsobject

        The payment methods available to the business recipient.

        Child parameters1
        • BeneficiaryCompanyPaymentMethodDetailsobject[]

          One entry per available payment method.

          Child parameters2
          • BeneficiaryCompanyPaymentMethodIdstring

            The internal ID of a payment method available to the business recipient, for example XTR94500.

          • BeneficiaryCompanyPaymentMethodNamestring

            The display name of the payment method, for example Bank.

      • OperationStatusobject

        The outcome of the call.

        Child parameters2
        • Successboolean

          Whether the operation succeeded (true) or failed (false).

        • Errorsstring[]

          The error messages when the call fails, as an array of strings. null on success, so decide with Success and use Errors only to explain a failure.

Related: Transfer from a business recipient's wallet · List a recipient's linked bank accounts · List a recipient's wallets · List payment methods for paying recipients