CustomerPaymentMethod
Describes the fields contained in REST messages and webhooks for payment methods saved to a customer profile
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| category | Category | ❌ | |
| fingerprint_token | str | ❌ | Hash of the card number, expiration date and CVV. Read-only. Relevant to cards. |
| id_ | str | ❌ | ID of the Payment Method object. String starting with card* or other* |
| image | str | ❌ | A URL to the image of the icon for the type of payment method. Response only |
| last4 | str | ❌ | last4 - Last four digits of the card number. Read-only. Relevant to cards |
| metadata | dict | ❌ | A JSON object defined by the client |
| name | str | ❌ | The name of the customer |
| network_reference_id | str | ❌ | Identifier for use in a recurring card payment. In recurring payments, use the network reference ID you got from the response or webhook when adding the payment method to the customer. In the payment_method.fields object, use it in place of the cvv field, along with the other required fields for the card payment method. This field cannot be used together with a payment method ID or a customer ID. Note that for all payments, you must use the network reference ID from adding the payment method to the customer. The response in each subsequent payment contains a different network reference ID, which is not for use in requests. Relevant to clients with PCI certification who have been authorized to use this feature |
| next_action | NextAction | ❌ | Indicates the next action for completing the payment. Response only. One of the following values are - _ 3d_verification - The next action is 3DS authentication. To simulate 3DS authentication in the sandbox, see Simulating 3DS Authentication. Relevant only to card payments. _ pending_capture - The next action is pending the capture of the amount. Relevant only to card payments when the amount is not zero. _ pending_confirmation - The next action is pending the confirmation for the payment. Relevant to all payment methods excluding card payment. _ not_applicable - The payment has completed or the next action is not relevant. |
| redirect_url | str | ❌ | URL where the customer is redirected for additional steps required for the payment. Response only. To simulate 3DS authentication in the sandbox, see Simulating 3DS Authentication - https://docs.rapyd.net/build-with-rapyd/reference-link/simulating-3ds-authentication |
| supporting_documentation | str | ❌ | Reserved. Response only. |
| token | str | ❌ | ID of the token that represents the card. String starting with card_. Relevant to cards. Relevant if the value of is_tokenizable is true for the payment method in the response to List Payment Methods by Country. See Payment Method Type Object at https://docs.rapyd.net/build-with-rapyd/reference-link/payment-method-type-object |
| type_ | str | ❌ | Name of the payment method type. For example, us_mastercard_card. To get a list of payment methods for a country, use List Payment Methods by Country. |
| webhook_url | str | ❌ | Reserved. Response only |
Build Your Own SDKs with liblab
Build developer friendly SDKs in minutes from your APIs