Create an authorization
/authorizationsAn authorization may carry network_token (token_reference, token_requestor_id, assurance_method, cryptogram_result) when the network detokenized it: the token must map to this card and requestor, be active and unexpired, the channel and merchant within its domain, a wallet token's cryptogram valid, its wallet consent enabled and its own controls met, or the authorization is declined with the token reason (05, 54, 57, 61, 62 or 63). Which token was used and what the check found is retained.
Headers
Idempotency-KeystringOptionalSend on every write that creates or changes money or state; a replay with the same key returns the original result with 200.
Body parameters
amountintegerRequiredchannelstringRequiredcountrystringRequiredcurrency_codestringRequiredfleet_receiptobject or nullOptional2 child attributes
payloadobjectRequired23 child attributes
authority_idstringRequiredauthority_sha256stringRequiredauthorization_idstringOptionalExample auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm
authorization_network_refstringOptionalcard_idstringRequiredExample card_2tVh8nqLxq4GbDe0K1F6S9zRcWm
currency_codestringRequireddriver_referencestringRequiredeffective_atstring · date-timeRequiredissued_atstring · date-timeRequiredkey_idstringRequiredkindstringRequiredAuthorize or presentment
linesarray of objectsOptional6 child attributes
product_codestringRequiredquantity_milliintegerRequiredreferencestringRequiredtotal_amountintegerRequiredunitstringRequiredunit_price_milli_minorintegerRequirednetworkstringRequiredoriginal_receipt_sha256stringOptionalproduct_code_systemstringOptionalproduct_code_versionstringOptionalreceipt_referencestringRequiredsource_evidenceobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredtotal_amountintegerRequiredtransaction_sha256stringOptionalvehicle_referencestringRequiredverificationstringRequiredDriver_vehicle_verified or cleared_fuel_purchase
versionstringRequiredsignaturestringRequiredmccstringRequiredmerchant_idstringOptionalmerchant_locationstringOptionalmerchant_namestringRequiredmerchant_postal_codestringOptionalThe merchant's postal code, when the network carries it
merchant_regionstringOptionalISO 3166-2 subdivision, full ("UA-43") or the part after the country
network_refstringRequirednetwork_tokenobject or nullOptionalToken data the network carries after detokenizing
4 child attributes
assurance_methodstringOptionalAs the network carries it; retained as evidence
cryptogram_resultstringRequiredValid, invalid or not_present, as the token service verified it
token_referencestringRequiredtoken_requestor_idstringRequiredpan_tokenstringRequiredpartial_approval_allowedbooleanOptionalthree_dsobject or nullOptionalAn e-commerce purchase's 3-D Secure authentication value and ECI
2 child attributes
authentication_valuestringRequiredecistringRequiredwallet_receiptobject or nullOptional2 child attributes
payloadobjectRequiredPayload is the versioned, domain-separated processor receipt. SigningBytes is normative: typed JSON in this field order with the timestamp normalized to UTC. Activate requires issuer_identity_verified; authorize requires cryptogram_verified.
15 child attributes
actionstringRequireddevice_sha256stringRequiredevent_referencestringRequiredevidence_referencestringRequiredevidence_sha256stringRequiredissued_atstring · date-timeRequiredkey_idstringRequirednetworkstringRequirednetwork_token_referencestringRequiredrequestor_idstringRequiredsequenceintegerRequiredtoken_idstringRequiredtransaction_sha256stringOptionalverificationstringOptionalversionstringRequiredsignaturestringRequiredStandard base64 Ed25519 signature
Returns
200 OK
approved_amountintegerOptionalA partial approval (response 10) or an increment
authorization_idstringRequiredExample auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm
decisionstringRequiredreasonstringRequiredreplayedbooleanRequiredresponse_codestringRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503