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.
This is not required for payment_request_code PT_CR_REPAYMENT; API will error out if provided.

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

Enum: "PT_TOPUP" "PT_COLLECTION" "PT_ACCOUNTDISB" "PT_CR_REPAYMENT" "PT_CLEARING" "PT_SCH_TRANSFER" "PT_RECURRING"
payment_balance
number <double>

Payment balance - Minimum Balance in destination account to trigger Payment

payment_guid
string or null <uuid>

Unique payment identifier. To be skipped in the request.

payment_chain
string or null <uuid>

For future use. Required to chain multiple payments.

response_code
string or null <= 16 characters

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

reason_code
string or null

Reason code for the payment.

requestor_wallet_guid
string or null <uuid>

Requestor wallet guid

payment_due_date
string <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
string <date-time>

Requested Scheduled date for the payment.

reference_code
required
string [ 1 .. 32 ] characters

Unique client identifier for the payment.

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"
object (AdditionalData)
error_code
string or 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 or 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
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",
      • "person": {
        • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
        • "birth_date": "string",
        • "email": "string",
        • "first_name": "string",
        • "middle_name": "string",
        • "last_name": "string",
        • "additional_data": {
          • "property1": "string",
          • "property2": "string"
          },
        • "mobile_number": "string",
        • "home_number": "string",
        • "office_number": "string",
        • "base_address": {
          • "city": "string",
          • "country": "str",
          • "address_line1": "string",
          • "address_line2": "string",
          • "postal_code": "string",
          • "state": "string"
          },
        • "mailing_address": {
          • "city": "string",
          • "country": "str",
          • "address_line1": "string",
          • "address_line2": "string",
          • "postal_code": "string",
          • "state": "string"
          },
        • "billing_address": {
          • "city": "string",
          • "country": "str",
          • "address_line1": "string",
          • "address_line2": "string",
          • "postal_code": "string",
          • "state": "string"
          },
        • "nationality": "str",
        • "ip_address": "string",
        • "person_status": "INCOMPLETE",
        • "identifications": [
          • {
            • "govt_id_type": "NOTPROVIDED",
            • "govt_id_number": "string"
            }
          ],
        • "client_reference_id": "string",
        • "verfication_mode": "string",
        • "verfication_level": "string",
        • "person_forget_mode": "string",
        • "person_forget_mode_date": "string",
        • "market_notification_optin": "string",
        • "market_notification_optin_date": "string",
        • "address_lat": 0,
        • "address_lon": 0,
        • "contact_type": "string",
        • "profile_dd_mode": "string",
        • "request_code": "string",
        • "wallet_id": "string",
        • "title": "string",
        • "mask_govt_id_number": "string",
        • "comments": "string",
        • "jurisdiction_state": "string",
        • "jurisdiction_country": "str",
        • "beneficial_ownership": 100,
        • "person_relations": [
          • {
            • "holder_person_guid": "67b4ee47-03be-4fa4-8a21-68a2b2312803",
            • "related_person_guid": "ad395ead-8b71-46c4-b7c0-1c41ae432595",
            • "person_relationship": "string",
            • "sys_utcinserted": "2019-08-24T14:15:22Z",
            • "sys_utcupdated": "2019-08-24T14:15:22Z"
            }
          ],
        • "mask_account_number": "string",
        • "ledger_balance": 0,
        • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
        • "person_supplement": {
          • "fiduciary_name": "string"
          }
        },
      • "account": {
        • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
        • "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
        • "account_currency": "string",
        • "account_name": "string",
        • "account_type": "GENERAL",
        • "available_balance": 0,
        • "ledger_balance": 0,
        • "suspense_balance": 0,
        • "advance_account_details": {
          • "account": {
            • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
            • "client_reference_id": "6970735e-7ed9-436b-b2f2-f25200dba6b0",
            • "start_date": "2019-08-24T14:15:22Z",
            • "limit": 0,
            • "outstanding_balance": 0,
            • "credit_product": "string",
            • "cycle": "string",
            • "status": "string",
            • "payment_summary": {
              • "outstanding_principal": 0,
              • "disbursement_amount": 0,
              • "processing_fees": 0,
              • "carriedbalance_fees": 0,
              • "total_repayment": 0,
              • "number_of_payments": 0
              },
            • "payment_schedule": [
              • {
                • "mob": null,
                • "date": null,
                • "disbursement_principal": null,
                • "disbursement_fee": null,
                • "total": null,
                • "fee": null,
                • "principal": null,
                • "balance": null,
                • "paid_principal": null,
                • "paid_interest": null,
                • "available_balance": null,
                • "cycle": null,
                • "type": null,
                • "status": null
                }
              ],
            • "available_date_range": [
              • {
                • "name": null,
                • "date": null
                }
              ]
            }
          },
        • "account_status": "SYSTEM",
        • "last_txn_guid": "100ead98-12b5-4d05-9c0c-900006fc8694",
        • "post_date": "2019-08-24T14:15:22Z",
        • "amount": 0,
        • "mask_account_number": "string",
        • "sys_utcinserted": "2019-08-24T14:15:22Z",
        • "status_change_nonmon_detail": {
          • "nonmon_guid": "3df16cd2-de7f-4e81-936e-7604855d1fd7",
          • "txn_date": "2019-08-24T14:15:22Z",
          • "channel_name": "string",
          • "request_code": "string",
          • "reason_code": "string",
          • "response_code": "string",
          • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
          • "hash_account_number": "string",
          • "remarks": "string",
          • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
          • "journal_guid": "019b8be6-224f-4e54-91ec-2a471754d334",
          • "support_user_guid": "334ad5b0-1427-4c28-aac8-2d6e9614b4d0",
          • "source_code": "string",
          • "source_user_guid": "0aaedba8-146e-40a6-ad5f-54c512699647",
          • "reference_number": "string",
          • "outsort_guid": "eef602a5-424d-4eae-b4d8-4521969d8873",
          • "order_guid": "dd878538-67b6-4e7d-8e8a-ddc3e971d02f",
          • "processing_start_date": "2019-08-24T14:15:22Z",
          • "processing_end_date": "2019-08-24T14:15:22Z",
          • "memo_code": "string"
          }
        },
      • "outside_instrument": {
        • "outside_instrument_guid": "f2fb9354-2f4f-40d1-819c-4ff2a66a4bd8",
        • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
        • "instrument_country": "string",
        • "instrument_type": "BANKDDA",
        • "instrument_name": "string",
        • "instrument_settlement_currency": "str",
        • "instrument_category": "INDIVIDUAL",
        • "instrument_usage": "string",
        • "mask_account_number": "string",
        • "account_details": {
          • "card_account": {
            • "card_number": "stringstrings",
            • "expiration_date": "stri",
            • "verification_code": "strin",
            • "expiry_status": "string"
            },
          • "bank_account": {
            • "account_type": "DDA",
            • "account_number": "string",
            • "routing_number": "string",
            • "rtp_routing_number": "string",
            • "bank_identifier": "string",
            • "bank_dba": "string",
            • "bank_address": {
              • "city": "string",
              • "country": "str",
              • "address_line1": "string",
              • "address_line2": "string",
              • "postal_code": "string",
              • "state": "string"
              },
            • "swift_code": "string",
            • "bank_phone": "string",
            • "description": "string",
            • "name_on_account": "string",
            • "accountholder_address": {
              • "city": "string",
              • "country": "str",
              • "address_line1": "string",
              • "address_line2": "string",
              • "postal_code": "string",
              • "state": "string"
              },
            • "additional_data": {
              • "property1": "string",
              • "property2": "string"
              }
            }
          },
        • "outside_iin": "string",
        • "financial_inst_name": "string",
        • "external_proxy_number": "string",
        • "instrument_verification_method": "BANK",
        • "instrument_status": "ACTIVE",
        • "acknowledgement": {
          • "tc_version": "string",
          • "acknowledgement_date": "string",
          • "ip_address": "string"
          },
        • "sys_utcinserted": "2019-08-24T14:15:22Z",
        • "base_outside_instrument_guid": "d06e7842-2b65-4e80-a035-958d85404833",
        • "account_name_inquiry_result": {
          • "full_name_match": "NONE",
          • "first_name_match": "NONE",
          • "middle_name_match": "NONE",
          • "last_name_match": "NONE"
          },
        • "instrument_ownership": "SELF",
        • "status_reason": "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",
      • "person": {
        • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
        • "birth_date": "string",
        • "email": "string",
        • "first_name": "string",
        • "middle_name": "string",
        • "last_name": "string",
        • "additional_data": {
          • "property1": "string",
          • "property2": "string"
          },
        • "mobile_number": "string",
        • "home_number": "string",
        • "office_number": "string",
        • "base_address": {
          • "city": "string",
          • "country": "str",
          • "address_line1": "string",
          • "address_line2": "string",
          • "postal_code": "string",
          • "state": "string"
          },
        • "mailing_address": {
          • "city": "string",
          • "country": "str",
          • "address_line1": "string",
          • "address_line2": "string",
          • "postal_code": "string",
          • "state": "string"
          },
        • "billing_address": {
          • "city": "string",
          • "country": "str",
          • "address_line1": "string",
          • "address_line2": "string",
          • "postal_code": "string",
          • "state": "string"
          },
        • "nationality": "str",
        • "ip_address": "string",
        • "person_status": "INCOMPLETE",
        • "identifications": [
          • {
            • "govt_id_type": "NOTPROVIDED",
            • "govt_id_number": "string"
            }
          ],
        • "client_reference_id": "string",
        • "verfication_mode": "string",
        • "verfication_level": "string",
        • "person_forget_mode": "string",
        • "person_forget_mode_date": "string",
        • "market_notification_optin": "string",
        • "market_notification_optin_date": "string",
        • "address_lat": 0,
        • "address_lon": 0,
        • "contact_type": "string",
        • "profile_dd_mode": "string",
        • "request_code": "string",
        • "wallet_id": "string",
        • "title": "string",
        • "mask_govt_id_number": "string",
        • "comments": "string",
        • "jurisdiction_state": "string",
        • "jurisdiction_country": "str",
        • "beneficial_ownership": 100,
        • "person_relations": [
          • {
            • "holder_person_guid": "67b4ee47-03be-4fa4-8a21-68a2b2312803",
            • "related_person_guid": "ad395ead-8b71-46c4-b7c0-1c41ae432595",
            • "person_relationship": "string",
            • "sys_utcinserted": "2019-08-24T14:15:22Z",
            • "sys_utcupdated": "2019-08-24T14:15:22Z"
            }
          ],
        • "mask_account_number": "string",
        • "ledger_balance": 0,
        • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
        • "person_supplement": {
          • "fiduciary_name": "string"
          }
        },
      • "account": {
        • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
        • "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
        • "account_currency": "string",
        • "account_name": "string",
        • "account_type": "GENERAL",
        • "available_balance": 0,
        • "ledger_balance": 0,
        • "suspense_balance": 0,
        • "advance_account_details": {
          • "account": {
            • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
            • "client_reference_id": "6970735e-7ed9-436b-b2f2-f25200dba6b0",
            • "start_date": "2019-08-24T14:15:22Z",
            • "limit": 0,
            • "outstanding_balance": 0,
            • "credit_product": "string",
            • "cycle": "string",
            • "status": "string",
            • "payment_summary": {
              • "outstanding_principal": 0,
              • "disbursement_amount": 0,
              • "processing_fees": 0,
              • "carriedbalance_fees": 0,
              • "total_repayment": 0,
              • "number_of_payments": 0
              },
            • "payment_schedule": [
              • {
                • "mob": null,
                • "date": null,
                • "disbursement_principal": null,
                • "disbursement_fee": null,
                • "total": null,
                • "fee": null,
                • "principal": null,
                • "balance": null,
                • "paid_principal": null,
                • "paid_interest": null,
                • "available_balance": null,
                • "cycle": null,
                • "type": null,
                • "status": null
                }
              ],
            • "available_date_range": [
              • {
                • "name": null,
                • "date": null
                }
              ]
            }
          },
        • "account_status": "SYSTEM",
        • "last_txn_guid": "100ead98-12b5-4d05-9c0c-900006fc8694",
        • "post_date": "2019-08-24T14:15:22Z",
        • "amount": 0,
        • "mask_account_number": "string",
        • "sys_utcinserted": "2019-08-24T14:15:22Z",
        • "status_change_nonmon_detail": {
          • "nonmon_guid": "3df16cd2-de7f-4e81-936e-7604855d1fd7",
          • "txn_date": "2019-08-24T14:15:22Z",
          • "channel_name": "string",
          • "request_code": "string",
          • "reason_code": "string",
          • "response_code": "string",
          • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
          • "hash_account_number": "string",
          • "remarks": "string",
          • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
          • "journal_guid": "019b8be6-224f-4e54-91ec-2a471754d334",
          • "support_user_guid": "334ad5b0-1427-4c28-aac8-2d6e9614b4d0",
          • "source_code": "string",
          • "source_user_guid": "0aaedba8-146e-40a6-ad5f-54c512699647",
          • "reference_number": "string",
          • "outsort_guid": "eef602a5-424d-4eae-b4d8-4521969d8873",
          • "order_guid": "dd878538-67b6-4e7d-8e8a-ddc3e971d02f",
          • "processing_start_date": "2019-08-24T14:15:22Z",
          • "processing_end_date": "2019-08-24T14:15:22Z",
          • "memo_code": "string"
          }
        },
      • "outside_instrument": {
        • "outside_instrument_guid": "f2fb9354-2f4f-40d1-819c-4ff2a66a4bd8",
        • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
        • "instrument_country": "string",
        • "instrument_type": "BANKDDA",
        • "instrument_name": "string",
        • "instrument_settlement_currency": "str",
        • "instrument_category": "INDIVIDUAL",
        • "instrument_usage": "string",
        • "mask_account_number": "string",
        • "account_details": {
          • "card_account": {
            • "card_number": "stringstrings",
            • "expiration_date": "stri",
            • "verification_code": "strin",
            • "expiry_status": "string"
            },
          • "bank_account": {
            • "account_type": "DDA",
            • "account_number": "string",
            • "routing_number": "string",
            • "rtp_routing_number": "string",
            • "bank_identifier": "string",
            • "bank_dba": "string",
            • "bank_address": {
              • "city": "string",
              • "country": "str",
              • "address_line1": "string",
              • "address_line2": "string",
              • "postal_code": "string",
              • "state": "string"
              },
            • "swift_code": "string",
            • "bank_phone": "string",
            • "description": "string",
            • "name_on_account": "string",
            • "accountholder_address": {
              • "city": "string",
              • "country": "str",
              • "address_line1": "string",
              • "address_line2": "string",
              • "postal_code": "string",
              • "state": "string"
              },
            • "additional_data": {
              • "property1": "string",
              • "property2": "string"
              }
            }
          },
        • "outside_iin": "string",
        • "financial_inst_name": "string",
        • "external_proxy_number": "string",
        • "instrument_verification_method": "BANK",
        • "instrument_status": "ACTIVE",
        • "acknowledgement": {
          • "tc_version": "string",
          • "acknowledgement_date": "string",
          • "ip_address": "string"
          },
        • "sys_utcinserted": "2019-08-24T14:15:22Z",
        • "base_outside_instrument_guid": "d06e7842-2b65-4e80-a035-958d85404833",
        • "account_name_inquiry_result": {
          • "full_name_match": "NONE",
          • "first_name_match": "NONE",
          • "middle_name_match": "NONE",
          • "last_name_match": "NONE"
          },
        • "instrument_ownership": "SELF",
        • "status_reason": "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",
  • "payment_schedule_date": "2019-08-24T14:15:22Z",
  • "reference_code": "string",
  • "payment_schedule": {
    • "payment_schedule_type": "IMMEDIATE",
    • "frequency": "DAY",
    • "period_value": 0,
    • "business_day_adjustment": "NEXT_BUSINESS_DAY",
    • "repeat_until_date": "2019-08-24T14:15:22Z",
    • "repeat_every": 0,
    • "payment_start_date": "2019-08-24T14:15:22Z",
    • "schedule_guid": "b6f4cc4c-e025-4982-9800-846c354bc66c"
    },
  • "foreign_exchange_purpose_code": "EFT_TRF_SELF",
  • "additional_data": {
    • "check_info": {
      • "template_alias": "string",
      • "payee_detail": {
        • "name": "string",
        • "address_line1": "string",
        • "address_line2": "string",
        • "city": "string",
        • "state": "string",
        • "zip": "string",
        • "country": "string"
        },
      • "ship_to_detail": {
        • "name": "string",
        • "address_line1": "string",
        • "address_line2": "string",
        • "city": "string",
        • "state": "string",
        • "zip": "string",
        • "country": "string"
        },
      • "shipping_method": "string",
      • "bulk_shipment_flag": true,
      • "return_to_detail": {
        • "name": "string",
        • "address_line1": "string",
        • "address_line2": "string",
        • "city": "string",
        • "state": "string",
        • "zip": "string",
        • "country": "string"
        },
      • "remittance_section_1": {
        • "remittance_s1_line1": "string",
        • "remittance_s1_line2": "string",
        • "remittance_s1_line3": "string",
        • "remittance_s1_line4": "string",
        • "remittance_s1_line5": "string",
        • "remittance_s1_line6": "string"
        },
      • "remittance_section_2": {
        • "remittance_s2_line1": "string",
        • "remittance_s2_line2": "string",
        • "remittance_s2_line3": "string"
        },
      • "check_stub_footer_text": "string",
      • "payer_detail": {
        • "payer_logo_file_name": "string",
        • "name": "string",
        • "address_line1": "string",
        • "address_line2": "string",
        • "city": "string",
        • "state": "string",
        • "zip": "string",
        • "country": "string"
        },
      • "check_void_after_days": 1,
      • "check_memo_line": "string",
      • "check_footer_text": "string",
      • "print_authorized_signatory1": true,
      • "print_authorized_signatory2": true,
      • "additional_detail": {
        • "check_stub_label1": "string",
        • "check_stub_label1_value": "string",
        • "check_stub_label2": "string",
        • "check_stub_label2_value": "string",
        • "check_label": "string",
        • "check_label_value": "string"
        },
      • "remittance_list": [
        • {
          • "remittance_line_1": "string",
          • "remittance_line_2": "string",
          • "remittance_line_3": "string",
          • "remittance_line_4": "string",
          • "remittance_line_5": "string",
          • "remittance_line_6": "string",
          • "remittance_line_7": "string",
          • "remittance_line_8": "string",
          • "remittance_line_9": "string",
          • "remittance_line_10": "string"
          }
        ]
      }
    },
  • "error_code": "string",
  • "error_description": "string"
}
Response samples
application/json
{
  • "maker_checker_request_details": {
    • "maker_checker_request_guid": "5b4ba6ad-f9f8-4604-bc16-4d6fad04e83a",
    • "decision_status": "string",
    • "request_code": "string",
    • "request_date": "2019-08-24T14:15:22Z",
    • "decision_date": "2019-08-24T14:15:22Z",
    • "expiration_date": "2019-08-24T14:15:22Z",
    • "journal_guid": "019b8be6-224f-4e54-91ec-2a471754d334",
    • "sys_utcinserted": "2019-08-24T14:15:22Z",
    • "sys_utcupdated": "2019-08-24T14:15:22Z",
    • "request_body": "string",
    • "reference_number": "string",
    • "memo_code": "string",
    • "txn_guid": "0017d7fb-f072-440d-86fd-a7ae6238e591",
    • "bank_eft_guid": "b91916c2-ae47-47fc-87e2-5a0a340e4c0b",
    • "nonmon_guid": "3df16cd2-de7f-4e81-936e-7604855d1fd7",
    • "maker_user_guid": "6a3025a8-52c5-4993-a0d8-d2f3b450d588",
    • "checker_user_guid": "5c30ec6c-41f0-48a2-accc-77266c5e2d94",
    • "amount": "string",
    • "source_account_guid": "c6f39c3e-af3d-4299-82a4-200c95106e9a",
    • "destination_account_guid": "25a72585-ce13-4787-8409-622cb0a0a90d",
    • "source_outside_instrument_guid": "d601c075-8930-447a-a0b4-35e2e866073d",
    • "destination_outside_instrument_guid": "13dd9db3-672c-432f-8508-da4deceec6ad",
    • "source_person_guid": "941dcb55-875a-4a4c-8057-d7a3cce7b080",
    • "destination_person_guid": "eec3495d-d3aa-41f2-9294-7b544c5b31a5",
    • "source_hash_account_number": "string",
    • "destination_hash_account_number": "string",
    • "source_program_guid": "98427da9-f0b1-4154-92f2-ed20266b0889",
    • "destination_program_guid": "fa634271-8fce-45f1-8c20-febf46d0c6a1",
    • "future_date": "2019-08-24T14:15:22Z",
    • "payment_guid": "ca76c87d-c08b-46dc-a069-5abd4a4ab259"
    },
  • "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",
      • "person": {
        • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
        • "birth_date": "string",
        • "email": "string",
        • "first_name": "string",
        • "middle_name": "string",
        • "last_name": "string",
        • "additional_data": {
          • "property1": "string",
          • "property2": "string"
          },
        • "mobile_number": "string",
        • "home_number": "string",
        • "office_number": "string",
        • "base_address": {
          • "city": "string",
          • "country": "str",
          • "address_line1": "string",
          • "address_line2": "string",
          • "postal_code": "string",
          • "state": "string"
          },
        • "mailing_address": {
          • "city": "string",
          • "country": "str",
          • "address_line1": "string",
          • "address_line2": "string",
          • "postal_code": "string",
          • "state": "string"
          },
        • "billing_address": {
          • "city": "string",
          • "country": "str",
          • "address_line1": "string",
          • "address_line2": "string",
          • "postal_code": "string",
          • "state": "string"
          },
        • "nationality": "str",
        • "ip_address": "string",
        • "person_status": "INCOMPLETE",
        • "identifications": [
          • {
            • "govt_id_type": "NOTPROVIDED",
            • "govt_id_number": "string"
            }
          ],
        • "client_reference_id": "string",
        • "verfication_mode": "string",
        • "verfication_level": "string",
        • "person_forget_mode": "string",
        • "person_forget_mode_date": "string",
        • "market_notification_optin": "string",
        • "market_notification_optin_date": "string",
        • "address_lat": 0,
        • "address_lon": 0,
        • "contact_type": "string",
        • "profile_dd_mode": "string",
        • "request_code": "string",
        • "wallet_id": "string",
        • "title": "string",
        • "mask_govt_id_number": "string",
        • "comments": "string",
        • "jurisdiction_state": "string",
        • "jurisdiction_country": "str",
        • "beneficial_ownership": 100,
        • "person_relations": [
          • {
            • "holder_person_guid": "67b4ee47-03be-4fa4-8a21-68a2b2312803",
            • "related_person_guid": "ad395ead-8b71-46c4-b7c0-1c41ae432595",
            • "person_relationship": "string",
            • "sys_utcinserted": "2019-08-24T14:15:22Z",
            • "sys_utcupdated": "2019-08-24T14:15:22Z"
            }
          ],
        • "mask_account_number": "string",
        • "ledger_balance": 0,
        • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
        • "person_supplement": {
          • "fiduciary_name": "string"
          }
        },
      • "account": {
        • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
        • "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
        • "account_currency": "string",
        • "account_name": "string",
        • "account_type": "GENERAL",
        • "available_balance": 0,
        • "ledger_balance": 0,
        • "suspense_balance": 0,
        • "advance_account_details": {
          • "account": {
            • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
            • "client_reference_id": "6970735e-7ed9-436b-b2f2-f25200dba6b0",
            • "start_date": "2019-08-24T14:15:22Z",
            • "limit": 0,
            • "outstanding_balance": 0,
            • "credit_product": "string",
            • "cycle": "string",
            • "status": "string",
            • "payment_summary": {
              • "outstanding_principal": 0,
              • "disbursement_amount": 0,
              • "processing_fees": 0,
              • "carriedbalance_fees": 0,
              • "total_repayment": 0,
              • "number_of_payments": 0
              },
            • "payment_schedule": [
              • {
                • "mob": null,
                • "date": null,
                • "disbursement_principal": null,
                • "disbursement_fee": null,
                • "total": null,
                • "fee": null,
                • "principal": null,
                • "balance": null,
                • "paid_principal": null,
                • "paid_interest": null,
                • "available_balance": null,
                • "cycle": null,
                • "type": null,
                • "status": null
                }
              ],
            • "available_date_range": [
              • {
                • "name": null,
                • "date": null
                }
              ]
            }
          },
        • "account_status": "SYSTEM",
        • "last_txn_guid": "100ead98-12b5-4d05-9c0c-900006fc8694",
        • "post_date": "2019-08-24T14:15:22Z",
        • "amount": 0,
        • "mask_account_number": "string",
        • "sys_utcinserted": "2019-08-24T14:15:22Z",
        • "status_change_nonmon_detail": {
          • "nonmon_guid": "3df16cd2-de7f-4e81-936e-7604855d1fd7",
          • "txn_date": "2019-08-24T14:15:22Z",
          • "channel_name": "string",
          • "request_code": "string",
          • "reason_code": "string",
          • "response_code": "string",
          • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
          • "hash_account_number": "string",
          • "remarks": "string",
          • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
          • "journal_guid": "019b8be6-224f-4e54-91ec-2a471754d334",
          • "support_user_guid": "334ad5b0-1427-4c28-aac8-2d6e9614b4d0",
          • "source_code": "string",
          • "source_user_guid": "0aaedba8-146e-40a6-ad5f-54c512699647",
          • "reference_number": "string",
          • "outsort_guid": "eef602a5-424d-4eae-b4d8-4521969d8873",
          • "order_guid": "dd878538-67b6-4e7d-8e8a-ddc3e971d02f",
          • "processing_start_date": "2019-08-24T14:15:22Z",
          • "processing_end_date": "2019-08-24T14:15:22Z",
          • "memo_code": "string"
          }
        },
      • "outside_instrument": {
        • "outside_instrument_guid": "f2fb9354-2f4f-40d1-819c-4ff2a66a4bd8",
        • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
        • "instrument_country": "string",
        • "instrument_type": "BANKDDA",
        • "instrument_name": "string",
        • "instrument_settlement_currency": "str",
        • "instrument_category": "INDIVIDUAL",
        • "instrument_usage": "string",
        • "mask_account_number": "string",
        • "account_details": {
          • "card_account": {
            • "card_number": "stringstrings",
            • "expiration_date": "stri",
            • "verification_code": "strin",
            • "expiry_status": "string"
            },
          • "bank_account": {
            • "account_type": "DDA",
            • "account_number": "string",
            • "routing_number": "string",
            • "rtp_routing_number": "string",
            • "bank_identifier": "string",
            • "bank_dba": "string",
            • "bank_address": {
              • "city": "string",
              • "country": "str",
              • "address_line1": "string",
              • "address_line2": "string",
              • "postal_code": "string",
              • "state": "string"
              },
            • "swift_code": "string",
            • "bank_phone": "string",
            • "description": "string",
            • "name_on_account": "string",
            • "accountholder_address": {
              • "city": "string",
              • "country": "str",
              • "address_line1": "string",
              • "address_line2": "string",
              • "postal_code": "string",
              • "state": "string"
              },
            • "additional_data": {
              • "property1": "string",
              • "property2": "string"
              }
            }
          },
        • "outside_iin": "string",
        • "financial_inst_name": "string",
        • "external_proxy_number": "string",
        • "instrument_verification_method": "BANK",
        • "instrument_status": "ACTIVE",
        • "acknowledgement": {
          • "tc_version": "string",
          • "acknowledgement_date": "string",
          • "ip_address": "string"
          },
        • "sys_utcinserted": "2019-08-24T14:15:22Z",
        • "base_outside_instrument_guid": "d06e7842-2b65-4e80-a035-958d85404833",
        • "account_name_inquiry_result": {
          • "full_name_match": "NONE",
          • "first_name_match": "NONE",
          • "middle_name_match": "NONE",
          • "last_name_match": "NONE"
          },
        • "instrument_ownership": "SELF",
        • "status_reason": "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",
      • "person": {
        • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
        • "birth_date": "string",
        • "email": "string",
        • "first_name": "string",
        • "middle_name": "string",
        • "last_name": "string",
        • "additional_data": {
          • "property1": "string",
          • "property2": "string"
          },
        • "mobile_number": "string",
        • "home_number": "string",
        • "office_number": "string",
        • "base_address": {
          • "city": "string",
          • "country": "str",
          • "address_line1": "string",
          • "address_line2": "string",
          • "postal_code": "string",
          • "state": "string"
          },
        • "mailing_address": {
          • "city": "string",
          • "country": "str",
          • "address_line1": "string",
          • "address_line2": "string",
          • "postal_code": "string",
          • "state": "string"
          },
        • "billing_address": {
          • "city": "string",
          • "country": "str",
          • "address_line1": "string",
          • "address_line2": "string",
          • "postal_code": "string",
          • "state": "string"
          },
        • "nationality": "str",
        • "ip_address": "string",
        • "person_status": "INCOMPLETE",
        • "identifications": [
          • {
            • "govt_id_type": "NOTPROVIDED",
            • "govt_id_number": "string"
            }
          ],
        • "client_reference_id": "string",
        • "verfication_mode": "string",
        • "verfication_level": "string",
        • "person_forget_mode": "string",
        • "person_forget_mode_date": "string",
        • "market_notification_optin": "string",
        • "market_notification_optin_date": "string",
        • "address_lat": 0,
        • "address_lon": 0,
        • "contact_type": "string",
        • "profile_dd_mode": "string",
        • "request_code": "string",
        • "wallet_id": "string",
        • "title": "string",
        • "mask_govt_id_number": "string",
        • "comments": "string",
        • "jurisdiction_state": "string",
        • "jurisdiction_country": "str",
        • "beneficial_ownership": 100,
        • "person_relations": [
          • {
            • "holder_person_guid": "67b4ee47-03be-4fa4-8a21-68a2b2312803",
            • "related_person_guid": "ad395ead-8b71-46c4-b7c0-1c41ae432595",
            • "person_relationship": "string",
            • "sys_utcinserted": "2019-08-24T14:15:22Z",
            • "sys_utcupdated": "2019-08-24T14:15:22Z"
            }
          ],
        • "mask_account_number": "string",
        • "ledger_balance": 0,
        • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
        • "person_supplement": {
          • "fiduciary_name": "string"
          }
        },
      • "account": {
        • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
        • "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
        • "account_currency": "string",
        • "account_name": "string",
        • "account_type": "GENERAL",
        • "available_balance": 0,
        • "ledger_balance": 0,
        • "suspense_balance": 0,
        • "advance_account_details": {
          • "account": {
            • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
            • "client_reference_id": "6970735e-7ed9-436b-b2f2-f25200dba6b0",
            • "start_date": "2019-08-24T14:15:22Z",
            • "limit": 0,
            • "outstanding_balance": 0,
            • "credit_product": "string",
            • "cycle": "string",
            • "status": "string",
            • "payment_summary": {
              • "outstanding_principal": 0,
              • "disbursement_amount": 0,
              • "processing_fees": 0,
              • "carriedbalance_fees": 0,
              • "total_repayment": 0,
              • "number_of_payments": 0
              },
            • "payment_schedule": [
              • {
                • "mob": null,
                • "date": null,
                • "disbursement_principal": null,
                • "disbursement_fee": null,
                • "total": null,
                • "fee": null,
                • "principal": null,
                • "balance": null,
                • "paid_principal": null,
                • "paid_interest": null,
                • "available_balance": null,
                • "cycle": null,
                • "type": null,
                • "status": null
                }
              ],
            • "available_date_range": [
              • {
                • "name": null,
                • "date": null
                }
              ]
            }
          },
        • "account_status": "SYSTEM",
        • "last_txn_guid": "100ead98-12b5-4d05-9c0c-900006fc8694",
        • "post_date": "2019-08-24T14:15:22Z",
        • "amount": 0,
        • "mask_account_number": "string",
        • "sys_utcinserted": "2019-08-24T14:15:22Z",
        • "status_change_nonmon_detail": {
          • "nonmon_guid": "3df16cd2-de7f-4e81-936e-7604855d1fd7",
          • "txn_date": "2019-08-24T14:15:22Z",
          • "channel_name": "string",
          • "request_code": "string",
          • "reason_code": "string",
          • "response_code": "string",
          • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
          • "hash_account_number": "string",
          • "remarks": "string",
          • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
          • "journal_guid": "019b8be6-224f-4e54-91ec-2a471754d334",
          • "support_user_guid": "334ad5b0-1427-4c28-aac8-2d6e9614b4d0",
          • "source_code": "string",
          • "source_user_guid": "0aaedba8-146e-40a6-ad5f-54c512699647",
          • "reference_number": "string",
          • "outsort_guid": "eef602a5-424d-4eae-b4d8-4521969d8873",
          • "order_guid": "dd878538-67b6-4e7d-8e8a-ddc3e971d02f",
          • "processing_start_date": "2019-08-24T14:15:22Z",
          • "processing_end_date": "2019-08-24T14:15:22Z",
          • "memo_code": "string"
          }
        },
      • "outside_instrument": {
        • "outside_instrument_guid": "f2fb9354-2f4f-40d1-819c-4ff2a66a4bd8",
        • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
        • "instrument_country": "string",
        • "instrument_type": "BANKDDA",
        • "instrument_name": "string",
        • "instrument_settlement_currency": "str",
        • "instrument_category": "INDIVIDUAL",
        • "instrument_usage": "string",
        • "mask_account_number": "string",
        • "account_details": {
          • "card_account": {
            • "card_number": "stringstrings",
            • "expiration_date": "stri",
            • "verification_code": "strin",
            • "expiry_status": "string"
            },
          • "bank_account": {
            • "account_type": "DDA",
            • "account_number": "string",
            • "routing_number": "string",
            • "rtp_routing_number": "string",
            • "bank_identifier": "string",
            • "bank_dba": "string",
            • "bank_address": {
              • "city": "string",
              • "country": "str",
              • "address_line1": "string",
              • "address_line2": "string",
              • "postal_code": "string",
              • "state": "string"
              },
            • "swift_code": "string",
            • "bank_phone": "string",
            • "description": "string",
            • "name_on_account": "string",
            • "accountholder_address": {
              • "city": "string",
              • "country": "str",
              • "address_line1": "string",
              • "address_line2": "string",
              • "postal_code": "string",
              • "state": "string"
              },
            • "additional_data": {
              • "property1": "string",
              • "property2": "string"
              }
            }
          },
        • "outside_iin": "string",
        • "financial_inst_name": "string",
        • "external_proxy_number": "string",
        • "instrument_verification_method": "BANK",
        • "instrument_status": "ACTIVE",
        • "acknowledgement": {
          • "tc_version": "string",
          • "acknowledgement_date": "string",
          • "ip_address": "string"
          },
        • "sys_utcinserted": "2019-08-24T14:15:22Z",
        • "base_outside_instrument_guid": "d06e7842-2b65-4e80-a035-958d85404833",
        • "account_name_inquiry_result": {
          • "full_name_match": "NONE",
          • "first_name_match": "NONE",
          • "middle_name_match": "NONE",
          • "last_name_match": "NONE"
          },
        • "instrument_ownership": "SELF",
        • "status_reason": "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",
  • "payment_schedule_date": "2019-08-24T14:15:22Z",
  • "reference_code": "string",
  • "payment_schedule": {
    • "payment_schedule_type": "IMMEDIATE",
    • "frequency": "DAY",
    • "period_value": 0,
    • "business_day_adjustment": "NEXT_BUSINESS_DAY",
    • "repeat_until_date": "2019-08-24T14:15:22Z",
    • "repeat_every": 0,
    • "payment_start_date": "2019-08-24T14:15:22Z",
    • "schedule_guid": "b6f4cc4c-e025-4982-9800-846c354bc66c"
    },
  • "foreign_exchange_purpose_code": "EFT_TRF_SELF",
  • "additional_data": {
    • "check_info": {
      • "template_alias": "string",
      • "payee_detail": {
        • "name": "string",
        • "address_line1": "string",
        • "address_line2": "string",
        • "city": "string",
        • "state": "string",
        • "zip": "string",
        • "country": "string"
        },
      • "ship_to_detail": {
        • "name": "string",
        • "address_line1": "string",
        • "address_line2": "string",
        • "city": "string",
        • "state": "string",
        • "zip": "string",
        • "country": "string"
        },
      • "shipping_method": "string",
      • "bulk_shipment_flag": true,
      • "return_to_detail": {
        • "name": "string",
        • "address_line1": "string",
        • "address_line2": "string",
        • "city": "string",
        • "state": "string",
        • "zip": "string",
        • "country": "string"
        },
      • "remittance_section_1": {
        • "remittance_s1_line1": "string",
        • "remittance_s1_line2": "string",
        • "remittance_s1_line3": "string",
        • "remittance_s1_line4": "string",
        • "remittance_s1_line5": "string",
        • "remittance_s1_line6": "string"
        },
      • "remittance_section_2": {
        • "remittance_s2_line1": "string",
        • "remittance_s2_line2": "string",
        • "remittance_s2_line3": "string"
        },
      • "check_stub_footer_text": "string",
      • "payer_detail": {
        • "payer_logo_file_name": "string",
        • "name": "string",
        • "address_line1": "string",
        • "address_line2": "string",
        • "city": "string",
        • "state": "string",
        • "zip": "string",
        • "country": "string"
        },
      • "check_void_after_days": 1,
      • "check_memo_line": "string",
      • "check_footer_text": "string",
      • "print_authorized_signatory1": true,
      • "print_authorized_signatory2": true,
      • "additional_detail": {
        • "check_stub_label1": "string",
        • "check_stub_label1_value": "string",
        • "check_stub_label2": "string",
        • "check_stub_label2_value": "string",
        • "check_label": "string",
        • "check_label_value": "string"
        },
      • "remittance_list": [
        • {
          • "remittance_line_1": "string",
          • "remittance_line_2": "string",
          • "remittance_line_3": "string",
          • "remittance_line_4": "string",
          • "remittance_line_5": "string",
          • "remittance_line_6": "string",
          • "remittance_line_7": "string",
          • "remittance_line_8": "string",
          • "remittance_line_9": "string",
          • "remittance_line_10": "string"
          }
        ]
      }
    },
  • "error_code": "string",
  • "error_description": "string"
}
Copyright © 2023 KeyBank & Qolo. All rights reserved.