Actualizar un payment intent

PUT

https://app.recurrente.com/api/payment_intents/:id

PUT

/api/payment_intents/:id

$ curl -X PUT https://app.recurrente.com/api/payment_intents/id \
>      -H "X-SECRET-KEY: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "payment_intent": {}
> }'

1 {
2   "id": "pa_123",
3   "receipt_number": 1,
4   "api_version": "2024-04-24",
5   "live_mode": true,
6   "created_at": "2024-01-15T09:30:00Z",
7   "checkout": {
8     "id": "ch_lmgbvesmihkqzma3",
9     "status": "paid",
10     "items": [
11       {
12         "id": "it_eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBQT09IiwiZXhwIjpudWxsLCJwdXIiOiJjaGVja291dF9pdGVtIn19",
13         "price_id": "price_rky4dog7",
14         "quantity": 2,
15         "metadata": {}
16       }
17     ],
18     "total_in_cents": 3000,
19     "subtotal_in_cents": 3500,
20     "discount": {
21       "amount_in_cents": 500,
22       "coupon": {
23         "id": "coup_ugwoxcp4",
24         "name": "VERANO25",
25         "discount_mode": "code",
26         "display_name": "string",
27         "amount_off_in_cents": 1500,
28         "percent_off": 1.1,
29         "automatically_applies": false,
30         "max_redemptions": 1,
31         "times_redeemed": 0,
32         "currency": "GTQ",
33         "duration": "once",
34         "expires_at": "2024-01-15T09:30:00Z",
35         "status": "active"
36       }
37     },
38     "currency": "GTQ",
39     "payment_method_types": [
40       "card",
41       "bank_transfer"
42     ],
43     "available_installments": [
44       3,
45       6
46     ],
47     "live_mode": true,
48     "success_url": "string",
49     "cancel_url": "string",
50     "expires_at": "2024-01-15T09:30:00Z",
51     "created_at": "2024-01-15T09:30:00Z",
52     "metadata": {},
53     "custom_fields": [
54       {
55         "field_id": "ccf_xxxxxxxxxxxx",
56         "key": "engraving",
57         "type": "text",
58         "value": "string"
59       }
60     ],
61     "transfer_setups": [
62       {
63         "id": "tr_4a7b9c8d",
64         "status": "pending",
65         "amount_in_cents": 1,
66         "amount_percent": 1.1,
67         "currency": "string",
68         "recipient_id": "ac_123456",
69         "purpose": "fund_split"
70       }
71     ],
72     "latest_intent": {
73       "id": "string",
74       "type": "string",
75       "created_at": "2024-01-15T09:30:00Z",
76       "data": {
77         "auth_code": "string"
78       }
79     },
80     "payment": {
81       "id": "string",
82       "paymentable": {
83         "type": "Subscription",
84         "id": "string",
85         "tax_name": "string",
86         "tax_id": "string",
87         "address": {
88           "address_line_1": "string",
89           "address_line_2": "string",
90           "city": "string",
91           "region": "string",
92           "country": "string",
93           "zip_code": "string"
94         },
95         "phone_number": "string"
96       }
97     },
98     "payment_method": {
99       "id": "string",
100       "type": "card",
101       "card": {
102         "last4": "4242",
103         "expiration_month": 12,
104         "expiration_year": 2028,
105         "network": "visa",
106         "issuer_name": "string"
107       },
108       "address": {
109         "address_line_1": "string",
110         "address_line_2": "string",
111         "city": "string",
112         "region": "string",
113         "country": "string",
114         "zip_code": "string"
115       },
116       "phone_number": "string"
117     }
118   },
119   "payment": {
120     "id": "string",
121     "paymentable": {
122       "type": "string",
123       "id": "string",
124       "tax_name": "string",
125       "tax_id": "string",
126       "address": {
127         "address_line_1": "string",
128         "address_line_2": "string",
129         "city": "string",
130         "region": "string",
131         "country": "string",
132         "zip_code": "string"
133       },
134       "phone_number": "string"
135     }
136   },
137   "customer_id": "string",
138   "user_id": "string",
139   "customer": {
140     "id": "string",
141     "email": "string",
142     "full_name": "string"
143   },
144   "failure_reason": "string",
145   "amount_in_cents": 500,
146   "currency": "GTQ",
147   "fee": 1,
148   "vat_withheld": 1,
149   "vat_withheld_currency": "string",
150   "used_presaved_payment_method": true,
151   "product": {
152     "id": "string"
153   },
154   "products": [
155     {
156       "id": "prod_9lstwgbr",
157       "status": "active",
158       "name": "El nombre de tu producto",
159       "description": "string",
160       "success_url": "string",
161       "cancel_url": "string",
162       "custom_terms_and_conditions": "string",
163       "phone_requirement": "optional",
164       "address_requirement": "none",
165       "billing_info_requirement": "optional",
166       "has_dynamic_pricing": false,
167       "payment_method_types": [
168         "card",
169         "bank_transfer"
170       ],
171       "available_installments": [
172         3,
173         6
174       ],
175       "prices": [
176         {
177           "id": "price_rky4dog7",
178           "status": "active",
179           "amount_in_cents": 500,
180           "currency": "GTQ",
181           "charge_type": "one_time",
182           "billing_interval": "month",
183           "billing_interval_count": 1,
184           "periods_before_automatic_cancellation": 1,
185           "free_trial_interval": "string",
186           "free_trial_interval_count": 1,
187           "proration_behavior": "none",
188           "billing_cycle_anchor_day": 1,
189           "defer_to_billing_day": true
190         }
191       ],
192       "storefront_link": "https://app.recurrente.com/s/surf-office/el-nombre-de-tu-producto",
193       "metadata": {},
194       "custom_fields": [
195         {
196           "id": "ccf_xxxxxxxxxxxx",
197           "key": "engraving",
198           "type": "text",
199           "label": {
200             "_original": "Mensaje de grabado",
201             "en": "Engraving message",
202             "es": "Mensaje de grabado"
203           },
204           "optional": false,
205           "minimum_length": 1,
206           "maximum_length": 1,
207           "default_value": "string",
208           "options": [
209             {
210               "label": "string",
211               "value": "string"
212             }
213           ]
214         }
215       ],
216       "quantity": 1
217     }
218   ],
219   "tax_invoice_url": "string",
220   "channel": "POS"
221 }

Adjunta una URL de factura fiscal a un payment intent exitoso. Solo los intents con status succeeded pueden ser actualizados.

Authentication

X-SECRET-KEYstring

Tu clave secreta de API.

Una llave de cuenta (sk_live_..., sk_test_...) opera sobre su propia cuenta y, con X-ACCOUNT-ID, sobre sus cuentas conectadas.

Una llave de organización (sk_org_live_..., sk_org_test_...) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con X-ACCOUNT-ID; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde 403 con code: organization_key_unsupported.

Tu clave secreta de API. Una llave de cuenta (`sk_live_...`, `sk_test_...`) opera sobre su propia cuenta y, con `X-ACCOUNT-ID`, sobre sus cuentas conectadas. Una llave de organización (`sk_org_live_...`, `sk_org_test_...`) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con `X-ACCOUNT-ID`; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde `403` con `code: organization_key_unsupported`.

Path parameters

idstringRequired

ID del payment intent

Request

This endpoint expects an object.

payment_intentobjectRequired

Response

Payment intent actualizado

idstringOptional

ID del payment intent

receipt_numberintegerOptional

Número de recibo

api_versionstringOptional

Versión de la API

live_modebooleanOptional

true en pagos reales; false en eventos simulados de checkouts de prueba.

created_atdatetimeOptional

Fecha de creación

checkoutobjectOptional

paymentobject or nullOptional

Información del pago

customer_idstringOptional

ID del cliente

user_idstringOptional

ID del usuario

customerobjectOptional

failure_reasonstring or nullOptional

Razón de fallo (si aplica)

amount_in_centsintegerOptional

Monto en centavos

currencystringOptional

Moneda

feeintegerOptional

Comisión cobrada

vat_withheldintegerOptional

IVA retenido

vat_withheld_currencystring or nullOptional

Moneda del IVA retenido

used_presaved_payment_methodbooleanOptional

Si se usó un método de pago guardado

productobjectOptional

productslist of objectsOptional

Productos incluidos en el pago

tax_invoice_urlstring or nullOptional

URL de la factura fiscal

channelenumOptional

Origen exacto del cobro con tarjeta. Usa POS para una terminal física, Celular como POS para cobros desde un teléfono y Link de pago para cobros con tarjeta en línea.

Errors

400

Bad Request Error