El objeto PaymentMethod
representa un método de pago del cliente.
Atributos
id_account string
Identificador único de la cuenta
gateway enum
El proveedor con el cual se inscribió el Payment Method.
product_ids list of strings
Listado de productos a los que esta asociado el Payment Method.
subscription_ids nullable list of strings
Listado de ids de subscripciones a los que esta asociado el Payment Method.
id_checkout_session nullable string
Identificador único de la Checkout Session con la que fue inscrito el Payment Method.
customer dictionary
El Customer al cual esta asociado el Payment Method.
Attribute | Type | Description |
---|---|---|
id | string | Identificador único del Customer. |
external_id | string | Identificador único en sus sistemas para identificar al Customer. |
string | Email del Customer. | |
goverment_id | string | Identificador de gobierno para el Customer (RUT en Chile, CPF/CNPJ en Brasil, CURP/RFC en México) |
name | string | Nombre del Customer. |
phone_number | string | Número de celular del Customer. |
payment_method dictionary
Attribute | Type | Description |
---|---|---|
id | string | Identificador único del Payment Method. |
external_id | string | Identificador único en sus sistemas para identificar el Payment Method. |
created_at | timestamp | Fecha de creación. |
status | enum | Estado del Payment Method. Posibles valores: chargeable , temporary_failed , permanent_failed , inscription_failed |
payment_method_metadata | nullable dictionary | Metadata asociada al Payment Method y campos variables. |
type | enum | El tipo del PaymentMethod |
card | nullable dictionary | Detalles del tipo card. |
bank_account | nullable dictionary | Detalles del tipo bank_account. |
pix | nullable dictionary | Detalles del tipo pix. |
boleto | nullable dictionary | Detalles del tipo boleto. |
Ejemplo
{
"payment_method": {
"created_at": "2025-05-05T18:51:24.768073",
"id": "pm_example_payment_method",
"type": "card",
"card": {
"institution_country": "MX",
"bank_id": "40036",
"bank_name": "mx_banco_santander",
"additional_data": null,
"bin": "424242",
"card_type": "credit",
"card_brand": "VISA",
"expiration_month": "02",
"expiration_year": "2030",
"card_holder": "jon doe",
"last_digits": "4242",
"token": "example_token",
"three_d_secure": false
},
"bank_account": null,
"pix": null,
"status": "chargeable",
"external_id": null,
"payment_method_metadata": {}
},
"customer": {
"id": "cus_examplecustomer",
"external_id": "example_external_id",
"email": "example@gmail.com",
"government_id": null,
"name": "Jon Doe",
"phone_number": "+52111111111"
},
"gateway": "payment_orchestration",
"product_ids": ["example_product_id_1"],
"subscription_ids": ["sub_example_subscription_1"],
"id_checkout_session": null,
"id_account": "acc_example_account"
}