Create Processor Attempt

POST

/api/:account_id/payments/processor_attempts/

POST

/api/:account_id/payments/processor_attempts/

$ curl -X POST https://app.paymentkit.com/api/account_id/payments/processor_attempts/ \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "payment_intent_id": "pi_3KJH4Y2eZvKYlo2C9X7a1b2c",
>   "amount_atom": 150000,
>   "currency": "usd"
> }'

1 {
2   "id": "pa_5F7d9b8e2c3a4b1d9e0f",
3   "account_id": "acct_9X8Y7Z6W5V4U3T2S1R0Q",
4   "payment_intent_id": "pi_3KJH4Y2eZvKYlo2C9X7a1b2c",
5   "payment_method_id": "pm_1GqIC8Lz0qyl6XeWl3a1b2c3",
6   "processor_id": "proc_1234567890abcdef",
7   "processor_name": "Stripe",
8   "customer_id": "cus_J8K9L0M1N2O3P4Q5R6S7",
9   "amount_atom": 150000,
10   "provider_type_fee_amount_atom": 4500,
11   "currency": "usd",
12   "status": "succeeded",
13   "created_at": "2024-01-15T09:30:00Z",
14   "updated_at": "2024-01-15T09:30:00Z",
15   "failure_code": "card_declined",
16   "failure_message": "The card was declined.",
17   "is_soft_decline": false,
18   "processor_metadata": {},
19   "network_identifiers": {
20     "network_transaction_id": "ntx_4f5e6d7c8b9a0d1e2f3g",
21     "acquirer_reference_number": "ARN1234567890",
22     "authorization_code": "AUTH987654",
23     "card_iin": "411111"
24   },
25   "captured_at": "2024-01-15T09:30:00Z",
26   "metadata": {},
27   "refunded_amount_atom": 0,
28   "refunded": false,
29   "dunning_attempt": 1
30 }

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

account_idstringRequired

Request

This endpoint expects an object.

payment_intent_idstringRequired

amount_atomintegerRequired

currencyenumRequired

ISO 4217 currency codes.

metadatamap from strings to any or nullOptional

Response

Successful Response

idstring

account_idstring

payment_intent_idstring

payment_method_idstring

processor_idstring

processor_namestring

customer_idstring

amount_atominteger

provider_type_fee_amount_atominteger

currencyenum

ISO 4217 currency codes.

statusstring

created_atdatetime

updated_atdatetime

failure_codestring or null

failure_messagestring or null

is_soft_declineboolean or null

processor_metadatamap from strings to any or null

network_identifiersobject or null

Chargeback-relevant payment network identifiers for a processor attempt.

Captured from the processor charge response at charge time and stored on ProcessorAttempt.processor_metadata. Used by chargeback-defense integrations (e.g. Chargeblast) to match disputes. Any field may be None when the processor did not return it (e.g. a non-card method, a setup-only attempt, or a processor that doesn’t expose the field).

captured_atdatetime or null

metadatamap from strings to any or null

refunded_amount_atomintegerDefaults to 0

refundedbooleanDefaults to false

dunning_attemptinteger or null

Errors

422

Unprocessable Entity Error