Originations

Overview

For full API reference on XPAY originations click here.

Push Funds

To push (credit) funds to one COS account and debit from another account:

POST /xpay/v1/payments
{
  "accountNumber": "1234567890",
  "senderName": "John Smith",
  "receiverIdentifier": "9876543210",
  "transactionType": "Push",
  "memo": "thank you",
  "data": "INV123",
  "transactionDescription": "string",
  "clientIdentifier": "string",
  "amount": 100
}

Note that the receiving account must be enabled to accept XPAY transfers. The receiver identifier is usually the account number you wish to send funds to, however depending on configuration it can be an alias value such as an email address. This allows the receiver to keep their account number hidden if they have privacy concerns.

Pull Funds

To pull (debit) funds from one COS account and credit another account:

POST /xpay/v1/payments
{
  "accountNumber": "1234567890",
  "senderName": "John Smith",
  "receiverIdentifier": "9876543210",
  "transactionType": "Pull",
  "memo": "bill pay",
  "data": "INV123",
  "transactionDescription": "string",
  "clientIdentifier": "string",
  "amount": 100
}

The request should look very similar to the Push request, with the primary difference being the transaction type. The receiver identifier specifies the account receiving the payment instruction, and will be debited if completed. The ability to debit an account will depend if that account is configured to allow pull transactions. In addition, debits will need to be approved to by the receiver before completing. It is not possible to enable automatic debit approvals.