Payments

post

https://devapi.qolopay.com/api/{version}/payments

Schedule a payment. This endpoint can be used to create a time based schedule or conditional payment schedule

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

version

string

required

Body Params

Payment Request Class

payer

array of objects | null

Payer: Identifies the original source of funds.
If both the account guid and an outside instrument guid are provided, funds will be pulled from outside instrument to the payer's account guid before being sent to the payee. However, the outside instrument guid must belong to the payer.

payer

payee

array of objects | null

Payee: Identifies the ultimate recipient of funds.
If both the account guid and an outside instrument guid are provided, funds will be deposited to the outside instrument from the payee's account guid after it is received from the payer. However, the outside instrument guid must belong to the payee.

This is not required for payment_request_code PT_CR_REPAYMENT; API will error out if provided.

payee

payment_amount

double

Payment amount. Skip for payment types PT_CLEARING and PT_CR_REPAYMENT as it defaults to 0; the value will be ignored if sent.

payment_base_currency

string

required

length ≥ 3

Three letter currency code

payment_description

string | null

Payment description

payment_request_code

string

enum

PT_TOPUP: For adding balance to an account if it reaches a certain balance.

PT_COLLECTION: For collecting funds from (multiple) external sources and collecting in a client collection account.

PT_ACCOUNTDISB: For disbursing funds from a client funding account to beneficiaries' account (or external account).

PT_CR_REPAYMENT: For repaying a funding account from external account.

PT_CLEARING: For sweeping the balance from a Clearing Account.

PT_SCH_TRANSFER: For scheduling a future-dated payment for Maker-Checker requests.

PT_RECURRING: For fixed (exact-amount) recurring payment schedules. The transfer amount is taken from payment_amount. Supports ACCOUNT2ACCOUNT, ACCOUNT2BANK, and BANK2ACCOUNT directions across all channels.

Allowed:

payment_balance

double

Payment balance - Minimum Balance in destination account to trigger Payment

payment_guid

uuid | null

Unique payment identifier. To be skipped in the request.

payment_chain

uuid | null

For future use. Required to chain multiple payments.

response_code

string | null

Response code for the payment. To be skipped in the request.

reason_code

string | null

Reason code for the payment.

requestor_wallet_guid

uuid | null

Requestor wallet guid

payment_due_date

date-time

Scheduled date for the payment based on the business day adjustment rule. Required for scheduling a one time payment request.

payment_schedule_date

date-time

Requested Scheduled date for the payment.

reference_code

string

required

length between 1 and 32

Unique client identifier for the payment.

payment_schedule

object

Payment Schedule Class

foreign_exchange_purpose_code

string

enum

additional_data

object

error_code

string | null

Fields for error handling in case of maker-checker rejections or other processing errors. These will be populated in the response when applicable but are not expected to be sent in the request.

error_description

string | null

Fields for error handling in case of maker-checker rejections or other processing errors. These will be populated in the response when applicable but are not expected to be sent in the request.

Responses

500

Server Error

201Returns the newly scheduled payment

400Bad request

401Unauthorized

404Program not found