Payment Method
A summary of a payment method.
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
Type |
string | ➖ | Always payment-method. |
payment-method |
ApprovalUrl |
string | ➖ | The optional URL that the buyer needs to be redirected to to further authorize their payment. | https://gr4vy.app/redirect/12345 |
Country |
string | ➖ | The 2-letter ISO code of the country this payment method can be used for. If this value is null the payment method may be used in multiple countries. | US |
Currency |
string | ➖ | The ISO-4217 currency code that this payment method can be used for. If this value is null the payment method may be used for multiple currencies. | USD |
Details |
PaymentMethodDetailsCard | ➖ | Details for credit or debit card payment method. | |
ExpirationDate |
string | ➖ | The expiration date for the payment method. | 12/30 |
Fingerprint |
string | ➖ | The unique hash derived from the payment method identifier (e.g. card number). | a50b85c200ee0795d6fd33a5c66f37a4564f554355c5b46a756aac485dd168a4 |
Label |
string | ➖ | A label for the card or the account. For a paypal payment method this is the user's email address. For a card it is the last 4 digits of the card. | 1234 |
LastReplacedAt |
DateTime | ➖ | The date and time when this card was last replaced by the account updater. | 2013-07-16T19:23:00.000+00:00 |
Method |
string | ✔️ | N/A | |
Mode |
string | ➖ | The mode to use with this payment method. | card |
Scheme |
string | ➖ | The scheme of the card. Only applies to card payments. | visa |
Id |
string | ✔️ | The ID for the payment method. | ef9496d8-53a5-4aad-8ca2-00eb68334389 |
MerchantAccountId |
string | ✔️ | The ID of the merchant account this buyer belongs to. | default |
AdditionalSchemes |
List<string> | ➖ | Additional schemes of the card besides the primary scheme. Only applies to card payment methods. | [ "eftpos-australia" ] |
CitLastUsedAt |
DateTime | ➖ | The timestamp when this payment method was last used in a transaction for client initiated transactions. | 2013-07-16T19:23:00.000+00:00 |
CitUsageCount |
long | ✔️ | The number of times this payment method has been used in transactions for client initiated transactions. | 50 |
HasReplacement |
bool | ✔️ | Whether this card has a pending replacement that hasn't been applied yet. | false |
LastUsedAt |
DateTime | ➖ | The timestamp when this payment method was last used in a transaction. | 2013-07-16T19:23:00.000+00:00 |
UsageCount |
long | ✔️ | The number of times this payment method has been used in transactions. | 100 |