Capture payment

post

https://testapi.multisafepay.com/v1/json/orders/{order_id}/capture

Capture the full or a partial amount for a credit or debit card payment.

How to test

Under Authentication > Query, enter a website API key from your TEST account.
Under Path params, enter the order ID.
Under Body params, fill in the required parameters.
Click Try it!

❗️ Never use a live API key!

💬 For support, email [email protected]

Path Params

order_id

string

required

The unique identifier of the order.

Max length: 50 characters.

Body Params

amount

integer

required

≥ 0

The payment amount in the currency's smallest unit:

Decimal currencies: Value for 10 EUR = 1000 (1000 cents)
Zero-decimal currencies: Value for 10 JPY = 10

Full captures: Specify the original amount.

Partial captures: Specify the amount to capture.

new_order_id

string

length ≤ 50

Your unique identifier for the captured order. Applies to partial captures only. If omitted, an ID is auto-generated.

new_order_status

string

enum

required

The order status.

Allowed:

invoice_id

string

length ≤ 50

Your unique identifier for the invoice, which appears in reports.

tracktrace_code

string

The track and trace code for the shipment (recommended).

carrier

string

The name of the shipping company (recommended).

reason

string

The reason for capturing the order.

description

string

Any additional information.

Responses

Language

Credentials

Query

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

How to test

200Request successful

404Error