Data Description for PayTo Agreements
The table below outlines the data that will need to be captured for the PayTo Agreement:
| Data Required | Payload Response | Description |
|---|---|---|
| Ezypay Customer ID | "customerId" | This is the unique identifier given to the customer when a customer has been created on via Ezypay's Create Customer API. |
| Account Holder's Name | "accountHolderName" | This is the full name used for the customer's bank account. |
| Account Type | "payToAccountType" | This is the type of account that the customer is using for PayTo: BSB and Bank account (BBAN) Later on AIIN (debit/credit card) and ALIA (PayID) will be displayed. |
| Account Holder's BSB Number This is a mandatory field if the "payToAccountType" is BBAN (BSB and Bank account) | "payToBBanBSB" | This is the BSB number of the customer's bank account. |
| Account Holder's Bank Account Number This is a mandatory field if the "payToAccountType" is BBAN (BSB and Bank account) | "payToBBanAccountNo" | This is the account number for the customer's bank account. |
| Acccount Holder's Details This is a mandatory field if the "payToAccountType" is ALIA (PayID) | "payToAliasType" | The following details must be captured for the customer if they are using PayID: - Email or telephone number - PayID - PayID account name |
| Acccount Holder's Details This is a mandatory field if the "payToAccountType" is ALIA (PayID) | payToAliasId" | The following details must be captured for the customer if they are using PayID: - Email or telephone number - PayID - PayID account name |
| Ezypay Merchant ID | "payToMerchantId" | This is the unique identifier (merchant ID) of the merchant when they onboarded Ezypay. |
| Ezypay Mandate Type ID | "payToMandateTypeId" | This is the unique identifier assigned to the merchant by Ezypay when they have been enabled to use PayTo services. |
| Mandate Status | "payToMandateStatus" | This is the status code given to the mandate. A mandate can have the following status code: - CRTD - CNCD - ACTV - SUSD |
| Mandate Reason | "payToMandateReason" | This is explanation of the "payToMandateStatus". The following is the reasons for the above status codes: - Created = CRTD - Cancelled = CNCD - Active = ACTV - Suspended =SUSD |
| PayTo Mandate ID | "payToMandateId" | This is a unique identifier used between Ezypay and their banking partner. |
Updated 11 months ago