Capture a payment

post

https://{environment}.joinforage.app/api/payments/{payment_ref}/capture/

This request will attempt to process a payment.

The payment will first be checked for a
consistent state, If these checks fail, a 400
response is returned and no payment methods
will be charged.

Once the payment is processed successfully, the
status of the payment will be updated to
succeeded.

Path Params

payment_ref

string

required

The reference hash of the payment

Body Params

An EBT cardholder's PIN data

This object contains an EBT cardholder's PIN data when one PIN entry is required

string

The PIN data

card_number_token

string

The token field of the TokenizedPaymentMethod.card object. This token is an input to Forage's secure PIN encryption.

Headers

Merchant-Account

string

required

A unique merchant ID that Forage provides during onboarding, as in 123ab45c67. The Merchant ID can be found in the Forage sandbox or production dashboard.

Idempotency-Key

string

required

An alphanumeric key that clients can use to identify repeated requests that are dropped in transit. Generate a distinct key for every unique request and only re-use keys for retries.

API-Version

string

The Forage version, represented as a string with the format of a YYYY-MM-DD date.

If not specified in the request header, then the version defaults to the value set in the Forage dashboard.

Responses

500

Server Errors Something went wrong on Forage's servers. Try again.

200OK - Success

400Bad Request The request was not accepted because of errors in the request body.

401Unauthorized Missing valid API key.

402Request Failed The request failed even though the parameters are valid. This often occurs due to a payment decline.

403Forbidden The API key lacks permissions to perform the request.

404Not Found The requested resource does not exist.

429Limit Reached Request limit reached.