Capture a Payment

Capture a Payment.

{ "payment": { "id": "pay_01G2SJNT6DEEWDFNAJ4XWDTHKE", "swap_id": null, "swap": {}, "cart_id": "string", "cart": {}, "order_id": "order_01G8TJSYT9M6AVS5N4EMNFS1EK", "order": {}, "amount": 100, "amount_refunded": 0, "provider_id": "manual", "captured_at": "2019-08-24T14:15:22Z", "canceled_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "currency_code": "usd", "data": {}, "idempotency_key": "string", "metadata": { "car": "white" }, "currency": { "symbol": "$", "symbol_native": "$", "name": "US Dollar", "includes_tax": false, "code": "usd" } } }

Responses

🟢200OK

application/json

Body

payment

object (Payment)

required

A payment is originally created from a payment session. Once a payment session is authorized, the payment is created to represent the authorized amount with a given payment method. Payments can be captured, canceled or refunded. Payments can be made towards orders, swaps, order edits, or other resources.

string

required

The payment's ID

Example:

pay_01G2SJNT6DEEWDFNAJ4XWDTHKE

swap_id

string | null

required

The ID of the swap that this payment was potentially created for.

Example:

null

swap

object | null

optional

The details of the swap that this payment was potentially created for.

cart_id

string | null

required

The ID of the cart that the payment session was potentially created for.

cart

object | null

optional

The details of the cart that the payment session was potentially created for.

order_id

string | null

required

The ID of the order that the payment session was potentially created for.

Example:

order_01G8TJSYT9M6AVS5N4EMNFS1EK

order

object | null

optional

The details of the order that the payment session was potentially created for.

amount

integer

required

The amount that the Payment has been authorized for.

Example:

100

amount_refunded

integer

required

The amount of the original Payment amount that has been refunded back to the Customer.

Default:

Example:

provider_id

string

required

The id of the Payment Provider that is responsible for the Payment

Example:

manual

captured_at

string <date-time> | null

required

The date with timezone at which the Payment was captured.

canceled_at

string <date-time> | null

required

The date with timezone at which the Payment was canceled.

created_at

string <date-time>

required

The date with timezone at which the resource was created.

updated_at

string <date-time>

required

The date with timezone at which the resource was updated.

currency_code

string

required

The 3 character ISO currency code of the payment.

Example:

usd

data

object

required

The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.

Example:

{}

idempotency_key

string | null

required

Randomly generated key used to continue the completion of a payment in case of failure.

metadata

object | null

required

An optional key-value map with additional details

Example:

{"car":"white"}

currency

object (Currency)

optional

Currency

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error