Skip to content

transactionpaymentmethod.md

Latest commit

 

History

History
32 lines (27 loc) · 15 KB

transactionpaymentmethod.md

File metadata and controls

32 lines (27 loc) · 15 KB

TransactionPaymentMethod

Example Usage

import { TransactionPaymentMethod } from "@gr4vy/sdk/models/components";

let value: TransactionPaymentMethod = {
  method: "gift-card",
};

Fields

Field Type Required Description Example
type "payment-method" ➖ 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 components.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). 20eb353620155d2b5fc864cc46a73ea77cb92c725238650839da1813fa987a17
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 Date ➖ The date and time when this card was last replaced by the account updater. 2013-07-16T19:23:00.000+00:00
method components.Method ✔️ N/A
mode components.Mode ➖ The mode to use with this payment method. card
scheme components.CardScheme ➖ The scheme of the card. Only applies to card payments. visa
id string ➖ The ID of the payment method. 852b951c-d7ea-4c98-b09e-4a1c9e97c077
approvalTarget components.ApprovalTarget ➖ The browser target that an approval URL must be opened in. If any or null, then there is no specific requirement. any
externalIdentifier string ➖ An external identifier that can be used to match the payment method against your own records. card-12345
paymentAccountReference string ➖ The payment account reference (PAR) returned by the card scheme. This is a unique reference to the underlying account that has been used to fund this payment method. V0010014629724763377327521982