Payments

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

Request
Security:
Bearer
path Parameters
version
required
string
Request Body schema: application/json
Array of objects or null (CreatePaymentPayer)

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.

Array of objects or null (CreatePaymentPayee)

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.

payment_amount
number <double>

Payment amount

payment_base_currency
required
string >= 3 characters

Three letter currency code

payment_description
string or null

Payment description

payment_request_code
string (PaymentRequestCode)

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).

Enum: "PT_TOPUP" "PT_COLLECTION" "PT_ACCOUNTDISB"
payment_balance
number <double>

Payment balance - Minimum Balance in destination account to trigger Payment

payment_guid
string or null <uuid>

Payment guid

payment_chain
string or null <uuid>

Payment chain

response_code
string or null <= 16 characters

Response Code

reason_code
string or null

Reason Code

requestor_wallet_guid
string or null <uuid>

Requestor wallet guid

payment_due_date
string <date-time>

Payment due date

reference_code
required
string [ 1 .. 32 ] characters

Reference code

object (PaymentScheduleRequest)

Payment Schedule Class

foreign_exchange_purpose_code
string (PaymentPurposeCode)
Enum: "EFT_TRF_SELF" "EFT_TRF_FAMILY" "EFT_TRF_EDU" "EFT_TRF_MED" "EFT_TRF_HOTEL" "EFT_TRF_TRAVEL" "EFT_TRF_BILL" "EFT_TRF_LOAN" "EFT_TRF_TAX" "EFT_TRF_RESPROP" "EFT_TRF_RENTPROP" "EFT_TRF_INSPREM" "EFT_TRF_INSINDM" "EFT_TRF_INSCLAIM" "EFT_TRF_INVMF" "EFT_TRF_INVSHARE" "EFT_TRF_DONATION" "EFT_TRF_INFSC" "EFT_TRF_PREXP" "EFT_TRF_FEETM" "EFT_TRF_FEECUST" "EFT_TRF_FEESPC" "EFT_TRF_EXPOFF" "EFT_TRF_EXPCONS" "EFT_TRF_FEEGDTR" "EFT_TRF_GDEXP" "EFT_TRF_GDDLV" "EFT_TRF_GDTRD"
error_code
string or null
error_description
string or null
Responses
201

Returns the newly scheduled payment

400

Bad request

401

Unauthorized

404

Program not found

500

Server Error

post/api/{version}/payments
Request samples
application/json
{
  • "payer": [
    • {
      • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
      • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
      • "card_proxy": "string",
      • "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
      • "outside_instrument_guid": "f2fb9354-2f4f-40d1-819c-4ff2a66a4bd8",
      • "preferred_transfer_type": "string",
      • "account_type": "string",
      • "instrument_type": "string"
      }
    ],
  • "payee": [
    • {
      • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
      • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
      • "card_proxy": "string",
      • "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
      • "outside_instrument_guid": "f2fb9354-2f4f-40d1-819c-4ff2a66a4bd8",
      • "preferred_transfer_type": "string",
      • "account_type": "string",
      • "instrument_type": "string"
      }
    ],
  • "payment_amount": 0,
  • "payment_base_currency": "string",
  • "payment_description": "string",
  • "payment_request_code": "PT_TOPUP",
  • "payment_balance": 0,
  • "payment_guid": "ca76c87d-c08b-46dc-a069-5abd4a4ab259",
  • "payment_chain": "19e771ce-e346-4119-b133-6e58f85f159f",
  • "response_code": "string",
  • "reason_code": "string",
  • "requestor_wallet_guid": "996c589d-2ec1-4921-a37b-692f64c4cb1c",
  • "payment_due_date": "2019-08-24T14:15:22Z",
  • "reference_code": "string",
  • "payment_schedule": {
    • "payment_schedule_type": "IMMEDIATE",
    • "frequency": "DAY",
    • "period_value": 0,
    • "repeat_until_date": "2019-08-24T14:15:22Z",
    • "payment_start_date": "2019-08-24T14:15:22Z",
    • "schedule_guid": "b6f4cc4c-e025-4982-9800-846c354bc66c"
    },
  • "foreign_exchange_purpose_code": "EFT_TRF_SELF",
  • "error_code": "string",
  • "error_description": "string"
}
Response samples
application/json
{
  • "payer": [
    • {
      • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
      • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
      • "card_proxy": "string",
      • "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
      • "outside_instrument_guid": "f2fb9354-2f4f-40d1-819c-4ff2a66a4bd8",
      • "preferred_transfer_type": "string",
      • "account_type": "string",
      • "instrument_type": "string"
      }
    ],
  • "payee": [
    • {
      • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
      • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
      • "card_proxy": "string",
      • "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
      • "outside_instrument_guid": "f2fb9354-2f4f-40d1-819c-4ff2a66a4bd8",
      • "preferred_transfer_type": "string",
      • "account_type": "string",
      • "instrument_type": "string"
      }
    ],
  • "payment_amount": 0,
  • "payment_base_currency": "string",
  • "payment_description": "string",
  • "payment_request_code": "PT_TOPUP",
  • "payment_balance": 0,
  • "payment_guid": "ca76c87d-c08b-46dc-a069-5abd4a4ab259",
  • "payment_chain": "19e771ce-e346-4119-b133-6e58f85f159f",
  • "response_code": "string",
  • "reason_code": "string",
  • "requestor_wallet_guid": "996c589d-2ec1-4921-a37b-692f64c4cb1c",
  • "payment_due_date": "2019-08-24T14:15:22Z",
  • "reference_code": "string",
  • "payment_schedule": {
    • "payment_schedule_type": "IMMEDIATE",
    • "frequency": "DAY",
    • "period_value": 0,
    • "repeat_until_date": "2019-08-24T14:15:22Z",
    • "payment_start_date": "2019-08-24T14:15:22Z",
    • "schedule_guid": "b6f4cc4c-e025-4982-9800-846c354bc66c"
    },
  • "foreign_exchange_purpose_code": "EFT_TRF_SELF",
  • "error_code": "string",
  • "error_description": "string"
}
Copyright © 2023 KeyBank & Qolo. All rights reserved.