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": "string",
>   "amount_atom": 1,
>   "currency": "aed"
> }'

1 {
2   "id": "string",
3   "account_id": "string",
4   "payment_intent_id": "string",
5   "payment_method_id": "string",
6   "processor_id": "string",
7   "processor_name": "string",
8   "customer_id": "string",
9   "amount_atom": 1,
10   "provider_type_fee_amount_atom": 1,
11   "currency": "aed",
12   "status": "string",
13   "created_at": "2024-01-15T09:30:00Z",
14   "updated_at": "2024-01-15T09:30:00Z",
15   "failure_code": "string",
16   "failure_message": "string",
17   "is_soft_decline": true,
18   "processor_metadata": {},
19   "network_identifiers": {
20     "network_transaction_id": "string",
21     "acquirer_reference_number": "string",
22     "authorization_code": "string",
23     "card_iin": "string"
24   },
25   "captured_at": "2024-01-15T09:30:00Z",
26   "metadata": {},
27   "refunded_amount_atom": 0,
28   "refunded": false,
29   "dunning_attempt": 1,
30   "statement_descriptor": "string",
31   "credential_source": "string",
32   "fallback_reason": "string",
33   "cryptogram_generated_at": "2024-01-15T09:30:00Z"
34 }

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 nullOptional

failure_messagestring or nullOptional

is_soft_declineboolean or nullOptional

processor_metadatamap from strings to any or nullOptional

network_identifiersobject or nullOptional

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 nullOptional

metadatamap from strings to any or nullOptional

refunded_amount_atomintegerOptionalDefaults to 0

refundedbooleanOptionalDefaults to false

dunning_attemptinteger or nullOptional

statement_descriptorstring or nullOptional

credential_sourcestring or nullOptional

fallback_reasonstring or nullOptional

cryptogram_generated_atdatetime or nullOptional

Errors

422

Unprocessable Entity Error