Sign in
Sandbox Testing

Submit a test PIN during sandbox development

⚠️ 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.

post/api/payments/{payment_ref}/collect_pin_backend/

Request body

pinstring required

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

Example request

{
  "pin": "1234"
}

Response

OK - Success

object required

Changes

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