Enumeration Values

📘

Coming soon

Credit card and direct debit transactions within the UK are not yet available.

This page lists possible values for different enumeration type fields specified in the APIs

Transaction Type

Appears as transaction_type or type
Exists in the following APIs and when these object are returned:

  • batch_transactions
  • transactions

Values

  • payment
  • return
  • refund
  • release
  • disbursement
  • fee
  • deposit
  • withdrawal
  • payment_funding
  • misc

Transaction Type Method

Appears as transaction_type_method or type_method
Exists in the following APIs and when these objects are returned:

  • batch_transactions
  • transactions

Values

  • direct_debit
  • credit_card
  • npp_payin (Australia)
  • bpay (Australia)
  • wallet_account_transfer
  • direct_credit
  • wire_transfer
  • misc

The table below explains the valid combinations of these two fields:

Transaction Type

Transaction Type Method

Notes

payment

credit_card

Appears in a transactions object for a credit card payment

payment

wallet_account_transfer

Appears in a transactions object when making a payment from a wallet account to an item

payment

wire_transfer

Appears in a transactions object for a wire transfer payment

payment

direct_debit

Appears in a transactions and batch_transactions object for a direct debit payment

disbursement

direct_credit

Appears in a transactions and batch_transactions object for a direct credit disbursement

disbursement

bpay

Appears in a batch_transactions object for a bpay disbursement

disbursement

misc

Appears in a transactions object for a bpay disbursement

deposit

bpay (Australia)

Appears in a transactions object for a bpay payin (deposit)

deposit

npp_payin (Australia)

Appears in a transactions object for a npp payin (deposit)

deposit

direct_credit

Appears in a transactions object for a virtual account (deposit)

bpay

bpay (Australia)

Appears in a batch_transactions object for a bpay payin for tracking the cases of bpay_pending and successful for the batch transactions of a BPAY payin

refund

credit_card

Appears in a transactions object for refunding a credit card

refund

wallet_account_transfer

Appears in a transactions object for refunding an item

fee

wallet_account_transfer

Appears in a transactions object for fees collection

payment_funding

credit_card

Appears in a batch_transactions object when settlement of credit card funds happens to the item payee/seller

withdrawal

misc

Appears in a transactions object and relates to a wallet account credit from item

withdrawal

direct_credit

Appears in a transactions object and relates to deposit funds APIs where funds are deposited into a wallet from a bank account

release

wallet_account_transfer

Appears in a transactions object and relates to an item debit to wallet account

misc

misc

Appears in a transactions object relates to credit to Zai from a wallet account

Account Type

Appears as account_type_id in accounts payload and has the following values

Type

Value

Digital Wallet

2000

Item Account

3000

Bank Account

9100

Card Account

9200

BPAY Account (Australia)

9700

Agreement Creation/Amendment Priority Type

Accepted as priority in request payload of below APIs -
Validate PayTo Agreement
Amend PayTo Agreement Details

Field Name

Value

Description

priority

ATTENDED

Setting the priority as attended provides an indication to the payer bank to notify the payer immediately about the pending agreement creation/amendment authorisation request

priority

UNATTENDED

Setting the priority as unattended provides an indication to the payer bank that it is not urgent to notify the payer immediately about the pending agreement creation/amendment authorisation request. The notification can be sent to the payer at a suitable time.

Payment Initiation Request Priority Type

Accepted as priority in request payload of below API -
Initiate PayTo Payment

Field Name

Value

Description

priority

ATTENDED

Setting the priority as attended indicates the payment request should be processed and concluded immediately.

So if the payer bank is not reachable due to technical issues, the request would be rejected immediately.

priority

UNATTENDED

Setting the priority as unattended indicates the payment request should be stored and processed later if the payer bank is not reachable due to technical issues.

So if the payer bank is not reachable due to technical issues, the request would be stored and processed later instead of being rejected immediately.

Agreement Type

Accepted as agreement_type in request payload of below API -
Validate PayTo Agreement

Field Name

Value

Description

agreement_type

AUPM (Authorised Payment Mandate)

This type of agreement must be authorised by the payer i.e. agreement will be Active only post successful authorisation. Payment requests can be initiated immediately once the agreement is "Active".

agreement_type

MGCR (Migrated by Creditor)

This type of agreement is created in order to migrate existing Direct Debit arrangement to be processed via the NPP using the PayTo rails. The agreement will be Active immediately (does not need payer authorisation as it is already pre-authorised in the existing BECS systems) however payment requests can be initiated after 5 calendar days post migration.


Did this page help you?