Authorizing an invoice

post

https://api.processout.com/invoices/{invoice_id}/authorize

Path Params

invoice_id

string

required

The invoice ID generated by ProcessOut during the invoice creation

Body Params

source

string

Source used to authorization the payment. Can be a card, a token or a gateway request.

save_source

boolean

Optional if you want us to save the payment source (card or APM) by creating a customer token during the authorisation

auto_capture_at

date

Optional if you want us to auto capture for you

initial_scheme_transaction_id

string

Override the scheme ID

incremental

boolean

Defaults to false

Request a pre-authorization that can be incremented at a later stage

preferred_scheme

string

Scheme the customer would prefer to process transaction on. Ex: carte bancaire. If there is already a default set on the card object, then you can override it using this field. Please use none if you wish to override it back to empty for this request.
Only supported on compatible payment providers.

external_three_d_s

object

Allow you to pass 3DS data obtained from an external provider outside of ProcessOut. Please contact your CSM to ensure the PSPs you are routing towards support this functionality.

Headers

Idempotency-Key

string

Unique key to your request that will be used for idempotency

Responses

Language

Credentials

Basic

base64

Loading…

Response

Choose an example:

application/json

200200

401401

404404

410410

4XX4XX