Update Payment Credential - Field Descriptions
The following tables describe the fields in the request and the response for the Update Payment Credential endpoint.
Request for Card Type
The following table describes the fields that can be included in the request where the paymentType for the credential is CARD.
Field | Description | Type | Min Length | Max Length | Mandatory |
|---|---|---|---|---|---|
type | The payment credential type. | AN | Yes | ||
expirationDate | The expiration date for the card. Format is YYYY-MM. | AN | 7 | 7 | Yes |
nameOnCard | The name that appears on the card. | AN | 1 | 120 | Yes |
cardType | The card type description. | AN | 1 | 70 | Yes |
currencyCode | The recipient card's currency code. | AN | 0 | 3 | No |
externalId | The client-provided identifier for the payment credential. | AN | 1 | 100 | No |
issuerName | The name of the issuer of the card. | AN | 1 | 150 | No |
preferredFor | Object that contains the type of account of the payment credential. | Object | Yes | ||
type | Indicates if a payment credential is a preferred Receiving, Sending, or Paying account. Receiving allows for funds to be pushed into the payment credential. Sending allows for funds to be sent from the payment credential. Paying allows for the payment credential to be used for purchases. More than one preferred type can be used. | Array | 0 | 3 | Yes |
preferredFor | Object | ||||
billingAddress | Object that contains details on the billing address of the customer. | Object | Yes | ||
country | The country code of the billing address. Uses the ISO-3166 format. | AN | 3 | 3 | Yes |
addressLine1 | The first line of the billing address. | AN | 0 | 99 | No |
addressLine2 | The second line of the billing address. | AN | 0 | 99 | No |
buildingNumber | The building number of the billing address. | AN | 1 | 60 | No |
city | The city of the billing address. | AN | 1 | 35 | No |
minorSubdivisionCode | The minor subdivision code of the billing address. | AN | 1 | 50 | No |
postalCode | The post code of the billing address. | AN | 1 | 16 | No |
state | The state of the billing address. | AN | 1 | 16 | No |
streetName | The street name of the billing address. | AN | 1 | 60 | No |
billingAddress | Object |
Request for Bank Type
The following table describes the fields that can be included in the request where the paymentType for the credential is BANK.
Field | Description | Type | Min Length | Max Length | Mandatory |
|---|---|---|---|---|---|
type | The payment credential type. | AN | Yes | ||
accountName | The bank account name. For example, the account holder name as recorded on the bank account. | AN | 1 | 70 | Yes |
accountNumber | The bank account number. | AN | 1 | 34 | Yes |
accountNumberType | The bank account number type. Valid values are 'IBAN', 'DEFAULT' and 'TOKEN'. If the IBAN format is not supported in a country, use DEFAULT. | AN | 4 | 7 | Yes |
bankName | The name of the bank. | AN | 1 | 50 | Yes |
countryCode | The bank account's country code. | AN | 3 | 3 | Yes |
currencyCode | The bank account's currency code. | AN | 3 | 3 | Yes |
accountType | The account type. | AN | 6 | 8 | No |
bankCode | The bank account's bank code. | AN | 1 | 12 | No |
bankCodeType | The bank account's bank code type. | AN | 3 | 9 | No |
BIC | The bank account's Business Identifier Code (BIC). | AN | 8 | 11 | No |
branchCode | The bank account's branch code. | AN | 1 | 12 | No |
externalId | The client-provided identifier for the payment credential. | AN | 1 | 100 | No |
preferredFor | Object that contains the type of account of the payment credential. | Object | Yes | ||
type | Indicates if a payment credential is a preferred Receiving, Sending, or Paying account. Receiving allows for funds to be pushed into the payment credential. Sending allows for funds to be sent from the payment credential. Paying allows for the payment credential to be used for purchases. More than one preferred type can be used. | Array | 0 | 3 | Yes |
preferredFor | Object | ||||
address | Object that contains details on the billing address of the bank. | Object | Yes | ||
country | The country code of the address. Uses the ISO-3166 format. | AN | 3 | 3 | Yes |
addressLine1 | The first line of the address. | AN | 0 | 99 | No |
addressLine2 | The second line of the address. | AN | 0 | 99 | No |
buildingNumber | The building number of the address. | AN | 1 | 60 | No |
city | The city of the address. | AN | 1 | 35 | No |
minorSubdivisionCode | The minor subdivision code of the address. | AN | 1 | 50 | No |
postalCode | The post code of the address. | AN | 1 | 16 | No |
state | The state of the address. | AN | 1 | 16 | No |
streetName | The street name of the address. | AN | 1 | 60 | No |
address | Object |
Response
If successful, a 204 No Content response is returned.
Updated 11 days ago