Payment parameters
This topic provides information on the required fields for making a Push to Card payment. To ensure a successful request, all required fields must be included. Optional fields can be added to enhance the functionality of the request.
Required fields
JSON field name |
Description |
Min length |
Max length |
|---|---|---|---|
|
The transaction execution date in ISO Date format (YYYY-MM-DD). |
10 |
10 |
|
The unique payment identifier assigned by the client. |
1 |
16 |
|
The payment initiation currency aligned to the program configuration, either |
3 |
3 |
|
The amount of the payment. Numeric characters only, no currency symbols. The amount must be greater than 0.01, with a maximum of two decimal places. Min and max lengths specified are for the numbers before the decimal places (1 line, 18 characters max). The maximum payment amount is 125,000.00. |
1 |
18 |
|
All Push to Card transactions must use |
6 |
6 |
|
The sender name. This value will be used as the sender name in the issuer notifications sent to the recipient. |
1 |
30 |
|
Your Push to Card Program ID. This is provided when onboarding to Push to Card. |
1 |
19 |
|
The financial institution identifier of sender. If processing payment in USD: If processing payment in CAD: |
8 |
8 |
|
The name of the recipient. No special characters are allowed. |
1 |
30 |
|
All Push to Card payments must use |
4 |
4 |
|
16-character card number. |
16 |
16 |
|
4-digit card expiration date (YYMM). |
4 |
4 |
Conditional fields
These fields are required when Push to Card payments are being made by a third-party payment provider, money service business, or ‘on behalf of’.
JSON field name |
Description |
Min length |
Max length |
|---|---|---|---|
|
Name of the ultimate debtor. No special characters are allowed, including ‘*/,$@& Mandatory for TP3 use-cases. |
1 |
20 |
|
Street name of the ultimate debtor. Special characters are not supported. Mandatory for TP3 use-cases. |
1 |
35 |
payments.debtor.ultimateDebtor.postalAddress.postalCode |
ZIP or postal code of the ultimate debtor. Dashes can be included. Avoid using the following characters: [#*&%$@=?{}"|&<>+":;!~`/\()''.] Mandatory for TP3 use-cases. |
1 |
9 |
payments.debtor.ultimateDebtor.postalAddress.townName |
City or town of the ultimate debtor. Special characters are not supported. Mandatory for TP3 use-cases. |
1 |
25 |
payments.debtor.ultimateDebtor.postalAddress.countrySubDvsn |
State or province of the ultimate debtor. Special characters are not supported. Mandatory for TP3 use-cases. |
2 |
2 |
payments.debtor.ultimateDebtor.postalAddress.country |
ISO 2-digit standard country code of the ultimate debtor. Mandatory for TP3 use-cases. |
2 |
2 |
Optional fields
While the following fields are not mandatory, it is recommended to share creditor address details if they are already being collected.
JSON field name |
Description |
Min length |
Max length |
|---|---|---|---|
|
Unstructured remittance information for the payment. If left blank, remittance information defaults to the value for debtorName. 1 line, 16 characters max. |
1 | 16 |
|
A code that specifies the purpose of the payment. A separate list of available codes for this field is provided. |
1 |
6 |
|
The sender’s VAT registration number or SBSRN. Contains the merchant’s Value-added tax (VAT) or Single Business Reference Number (SBRN) for the business sender's tax identification. Issuers may require this for reporting or other regulatory purposes. |
1 | 20 |
|
Address type of recipient. Possible values are:
|
1 |
4 |
|
Street name of recipient's address. Special characters are not supported. Required for Canada domestic payments use cases. |
1 |
|
|
Building name or number of the recipient's address. Special characters are not supported |
1 |
16 |
|
ZIP or portal code of recipient. Dashes can be included. Avoid using the following characters: Required for Canada domestic payments use cases. |
1 |
|
|
City or town of the recipient. Special characters are not supported. |
1 | 25 |
|
ISO 2-digit standard country code of the recipient. Required for Canada domestic payments use cases. |
2 | 2 |
|
State or province of recipient. Special characters are not supported. |
2 | 2 |
payments.debtor.ultimateDebtor.dateAndPlaceOfBirth.birthDate |
Birth date of the ultimate debtor in YYYY-MM-DD format. |
1 |
10 |
payments.debtor.ultimateDebtor.postalAddress.addressType |
Address type of the ultimate debtor. Possible values are:
|
1 |
4 |
payments.debtor.ultimateDebtor.postalAddress.buildingNumber |
Special characters are not supported. |
1 |
16 |
Next steps
Review Push to Card resources.