RArainforestpay
Payins

Capture payin

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

post/v1/payins/{payin_id}/capture

Request

  • Base URL
    https://api.sandbox.rainforestpay.com
  • URL
    https://api.sandbox.rainforestpay.com/v1/payins/{payin_id}/capture
  • Auth
    HTTP bearer

Parameters

#/paths/~1v1~1payins/get/parameters/0 (unresolved $ref)
#/paths/~1v1~1payins~1{payin_id}/get/parameters/1 (unresolved $ref)

Request body

amountinteger

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.

metadataSchema (unresolved $ref)

Response

OK

statusStatus (unresolved $ref)
dataData (unresolved $ref)
errorsErrors (unresolved $ref)

Changes

No recorded changes to this operation across all 1 revision of this API.