Capture payin

post

https://api.sandbox.rainforestpay.com/v1/payins/{payin_id}/capture

Capture an authorized payin. The payin status must be Authorized to capture.

Path Params

payin_id

string

required

The unique payin identifier.

Prefix is "pyi" in production and "sbx_pyi" in sandbox.

Body Params

amount

integer

≥ 1

The amount to capture, in minor units. Must be less than or equal to the amount authorized. If omitted or set to 0, the full authorized amount will be captured.

amount_splits

object

Update the amount split, representing how the payin should be split between the merchant and the platform. If omitted, the amount split defined on the payin config will be used.

metadata

object

Update the metadata. If metadata is already set on the payin_config, both metadata objects will be merged together. If omitted, the metadata defined on the payin_config will be used.

Headers

Rainforest-Api-Version

string

enum

Defaults to 2024-10-16

Allowed:

Responses

Language

Credentials

Bearer

APIKey

URL

Response

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

application/json

200OK

400Bad request, check for validation errors.

401Authorization missing or invalid.

403Authorization insufficient for requested action.

404Resource not found.

5XXUnexpected error.