v1

latestOpenAPI 3.0.3MIT2026-07-2428350487.0 KB

Payment Instrument Verification

Verify details held by a PSP

Request for verification of details held by a payment service provider (PSP).

PSPs may offer functionality to verify details held by them.

This endpoint accepts information the consumer wishes to verify, and will return information provided by the PSP on whether that information matches their records.

post/payment-instrument-verifications

Request body

pspstring required

Name of Payment Service Provider (PSPs).

Please see PSP Integrations for a list of possible PSPs.

Example request

{
  "psp": "Checkout.com",
  "verificationDetails": {
    "type": "trustly",
    "firstName": "John",
    "lastName": "Smith",
    "customerId": "def456",
    "country": "GB",
    "locale": "en_GB",
    "email": "a.b@example.com",
    "successUrl": "https://myurl.com/success/f219ea52-d91f-4059-a560-8dd7cbd31fd0",
    "errorUrl": "https://myurl.com/error",
    "ipAddress": "123.100.100.200",
    "documentId": "ABC-123456",
    "phoneNumber": "+44 123 1110000",
    "dateOfBirth": "2000-01-01"
  }
}

Response

Verification request completed successfully.

idstring required

The ID of this request. If you can include these when querying the outcome of individual requests, we can track down the root cause faster.

verificationIdstring required

The ID of the verification record.

pspstring required

Name of Payment Service Provider (PSPs).

Please see PSP Integrations for a list of possible PSPs.

codestring required

Response Code signifying the outcome of the request.

messagestring required

A description of the outcome of the request.

Example response

{
  "id": "a7f45953-1e8b-4f33-87b0-3293f4f6972f",
  "verificationId": "9450a0b0-c62a-457f-9eb0-39c36d883557",
  "psp": "Checkout.com",
  "code": "1000",
  "verificationResult": {
    "type": "trustly",
    "actionRequired": true
  }
}