Submit a test PIN during sandbox development

post

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

Use For Sandbox Only

Only use this endpoint during sandbox testing. It cannot be used in production.

A POST request to /payments/{payment_ref}/collect_pin_backend/ programmatically associates a test PIN with an existing Payment object.

Use this endpoint to automate sandbox testing when you're building an integration that defers payment capture to the server.

Path Params

payment_ref

string

required

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

Body Params

string

required

A test four-digit PIN number, represented as a string.

Headers

Authorization

string

required

An OAuth 2.0 authentication token that validates the request. Send a POST to the /o/token/ endpoint to generate an authentication token. Pass the token in this header after the word Bearer and a whitespace, for example Bearer <api_key>.

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.

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Choose an example:

application/json

200OK - Success

400Bad Request

401Unauthorized

403Forbidden

404Not Found

409Conflict

429Too Many Requests

500Internal Server Error