Get Instrument Verification Sessions

GET 
/v2/customers/:customerId/instrument-verifications

Returns a list of instrument verification sessions for the customer. The list does not return the secure code so it can not be used to build redirect URL.

Request

Path Parameters

customerId stringrequired

The wallet customer id

Query Parameters

sessionStatus Instrument Verification Status

Possible values: [ACTIVE, ONGOING_VERIFICATION, AWAITING_USER_INPUT, COMPLETED, FAILED]

Filter Instrument Verification by status.

limit integer

Possible values: >= 1 and <= 50

Default value: 10

This is the requested number of records to return. Max = 50. Default = 10.

offset integer

Default value: 0

This is the requested starting position of the response entries, where 0 is the first record. Default = 0.

Responses

200

OK

application/json

Schema

Schema

instrumentVerifications object[]

meta

object

Contains paging information regarding the returned records, when response is paginated.

The input for paginated query contains two parameters:

• limit - This is the requested number of records to return. Defaults to 10 and maximum is 50.
• offset - This is the requested starting position of the response, where 0 is the first record. Default = 0.

Note! The total number of records is not returned, to prevent queries spanning on all records. If numberOfRecords<limit, this means no further pages are available. On request of offset beyond the last record, the returned numberOfRecords is 0.

The number of previous pages can be calculated by dividing offset to limit.

numberOfRecords integer

This is the number of records returned in the lookup. Always numberOfRecords is smaller than or equal to limit.

limit integer

This is the requested number of records to be returned per page.

offset integer

This is the requested starting position of the response, where 0 is the first record.

page integer

This is the page of records on which the lookup starts. The starting page is 1.

Example (from schema)

{
  "instrumentVerifications": [
    {
      "instrumentType": "CARD",
      "returnUrl": "https://some-process.paysafe.com/",
      "id": "2cb56b2749af52d6b257054ef3de0",
      "redirectUrl": "https://some-process.paysafe.com/",
      "creationTime": "2021-07-15T17:54:12Z",
      "expirationTime": "2021-07-15T17:54:12Z",
      "instrument": {
        "id": "1001",
        "instrumentType": "CARD"
      },
      "sessionStatus": "ACTIVE",
      "statusReason": "UNSUPPORTED_BANK"
    }
  ],
  "meta": {
    "numberOfRecords": 1,
    "limit": 10,
    "offset": 0,
    "page": 1
  }
}

Get instrument verification list with default paging params

{
  "instrumentVerifications": [
    {
      "instrumentType": "US_BANK_ACCOUNT",
      "returnUrl": "https://some-process.paysafe.com/",
      "id": "2cb56b2749af52d6b257054e",
      "redirectUrl": "https://pi-verify.eu-mprod.sandbox.dw-cloud.net/instruments/verifications/fa2830cb8ea46b43577a7b8ded0ed9b945e648a42ebdf82c3c8e05ff30f293a3/initiate",
      "creationTime": "2021-07-15T17:54:12Z",
      "expirationTime": "2021-07-15T17:56:12Z",
      "sessionStatus": "ACTIVE"
    }
  ],
  "meta": {
    "numberOfRecords": 1,
    "limit": 10,
    "page": 0,
    "offset": 0
  }
}

404

Not Found

application/json

Schema

Schema

error

object

Represents details of an error.

code string

The error code.

message string

The description of the error.

details string[]

Details for the errors of any parameter value.

fieldErrors

object[]

List of field errors associated with the main error.

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

Not found error

{
  "error": {
    "code": "5269",
    "message": "Entity not found",
    "details": [
      "The ID(s) specified in the URL do not correspond to the values in the system."
    ]
  }
}

500

Internal Server Error

application/json

Schema

Schema

error

object

Represents details of an error.

code string

The error code.

message string

The description of the error.

details string[]

Details for the errors of any parameter value.

fieldErrors

object[]

List of field errors associated with the main error.

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

Internal server error

{
  "error": {
    "code": "1000",
    "message": "Internal Error",
    "details": [
      "An internal error occurred."
    ]
  }
}

Loading...