HomeGuidesReference↗ Forage Dashboard
Log In
Reference

Capture a Payment during sandbox testing

post
https://{environment}.joinforage.app/api/payments//capture-sync/

A POST request to /payments/{payment_ref}/capture-sync/ programmatically captures an existing Payment object.

Use this endpoint to automate sandbox testing.

Path Params
string
required

A unique reference hash for the Forage Payment object, returned when the Payment was created.

Headers
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.

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.

Responses

Updated about 2 months ago

Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated about 2 months ago