PaymentOptions
A payment method type is a type of payment method that any customer can use, for example, eemastercard_card, Mastercard for Estonia. When it is added to a customer profile, it becomes a payment method that is specific to that one customer. The name of the payment method type starts with a prefix for the country, the 2-letter ISO 3166-1 alpha-2 code. If the payment method is valid in multiple countries, the prefix is xx. The payment method type has a suffix with one of the following values - _bank - Bank transfer or bank redirect _card - Credit card, debit card or other card _cash - Cash _ewallet - Local eWallet
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| address | Address | ❌ | address associated with this specific Rapyd entity Payment/Customer etc... |
| amount_range_per_currency | List[PaymentAmountRangePerCurrencyInner] | ❌ | Indicates the amount range for the payment method's currencies. Each object contains the following fields:_ currency - Three-letter ISO 4217 format of currency_ maximum_amount - The maximum payment amount* minimum_amount - The minimum payment amount |
| bin_details | BinDetails | ❌ | Bank Identification Number (BIN) details. Read-only. Object containing the following fields - _ bin_number - BIN number _ country - The two-letter ISO 3166-1 ALPHA-2 code for the country. Uppercase. _ funding - Type of card funding. One of the following [credit, debit, prepaid, unknown] _ bank - Name of the issuing bank. Relevant to cards |
| category | Category | ❌ | |
| conditions | List[Condition] | ❌ | |
| country | str | ❌ | |
| currencies | List[str] | ❌ | |
| customer | Customer | ❌ | customer |
| fingerprint | str | ❌ | Hash of the card number, expiration date and CVV. Read-only. Relevant to cards |
| image | str | ❌ | A URL to the image of the icon for the type of payment method. Response only |
| instructions | str | ❌ | Instructions for the field. Response only |
| is_cancelable | bool | ❌ | Indicates whether a payment made with this payment method can be canceled. Response only |
| is_expirable | bool | ❌ | Indicates whether the merchant can set an expiration time for the customer to complete the payment. Response only |
| is_online | bool | ❌ | Indicates whether the payment is completed immediately online. Response only |
| is_refundable | bool | ❌ | Indicates whether the payment method type supports refunds |
| is_required | bool | ❌ | Whether the field is required for using the payment method. When the conditions defined by conditions are met, the field is required even though the value of is_required is false. Response only |
| is_tokenizable | bool | ❌ | Indicates whether the token of the payment method can be used in a collect operation |
| is_virtual | bool | ❌ | Indicates whether a Web-based version of the payment method type exists |
| last4 | str | ❌ | last4 - Last four digits of the card number. Read-only. Relevant to cards |
| maximum_expiration_seconds | int | ❌ | The maximum time (in seconds) that the merchant can set for completing the payment. Relevant when is_expirable is true. Response only |
| minimum_expiration_seconds | int | ❌ | The minimum time (in seconds) that the merchant can set for completing the payment. Relevant when is_expirable is true. Response only |
| multiple_overage_allowed | bool | ❌ | Indicates whether multiple overage charges are allowed for this payment method type |
| name | str | ❌ | The name of the payment method, in user-friendly terms. For example, 'Ireland Visa card'. Response only |
| payment_flow_type | PaymentOptionsPaymentFlowType | ❌ |
PaymentOptionsPaymentFlowType
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| DIRECT | str | ✅ | "direct" |
| EWALLET | str | ✅ | "eWallet" |
| EWALLETPAYOUT | str | ✅ | "ewallet_payout" |
| CARD | str | ✅ | "card" |
| REDIRECTURL | str | ✅ | "redirect_url" |
Build Your Own SDKs with liblab
Build developer friendly SDKs in minutes from your APIs