Capture an invoice

post

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

Path Params

invoice_id

string

required

The invoice ID generated by ProcessOut during the invoice creation

Body Params

source

string

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

invoice_detail_ids

array of strings

Array of invoice details created with the invoice to capture.
Only supported on compatible payment providers

invoice_detail_ids

capture_amount

string

Amount to capture partially the transaction

capture_statement_descriptor

string

Some payment providers are supporting different statement descriptor for the capture. Use this field to send a different one. By default, the one sent during the authorization will be forwarded.

initial_scheme_transaction_id

string

Override the scheme ID

split_allocations

array of objects

An array of allocation objects that defines how the capture payment should be divided among different recipients. Each object in this array represents one "split" of the total invoice amount. This object will override the invoice's default split allocations.

split_allocations

capture_type

string

Whether this partial capture is "final" or "non-final".

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