Get Instrument Verifications for Customer
GET/customers/:customerId/instrument-verifications
Returns a list instrument verification sessions for customer. The list does not return the secure code so it can not be used to build redirect URL.
Request
Path Parameters
The wallet customer id
Query Parameters
Possible values: >= 1
and <= 50
Default value: 10
This is the requested number of records to return. Max = 50. Default = 10.
Default value: 0
This is the requested starting position of the response entries, where 0 is the first record. Default = 0.
Possible values: [ACTIVE
, ONGOING_VERIFICATION
, AWAITING_USER_INPUT
, COMPLETED
, FAILED
]
Filter Instrument Verification by status.
Responses
- 200
- 404
- 500
OK
- application/json
- Schema
- Example (from schema)
- Example1
Schema
- 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.
meta
object
Contains paging information regarding the returned records, when response is paginated.
The input for paginated query contains two parameters:
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 returnednumberOfRecords
is 0.
The number of previous pages can be calculated by dividing offset
to limit
.
This is the number of records returned in the lookup. Always numberOfRecords
is smaller than or equal to limit
.
This is the requested number of records to be returned per page.
This is the requested starting position of the response, where 0 is the first record.
This is the page of records on which the lookup starts. The starting page is 1.
{
"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
}
}
{
"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
}
}
Not Found
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
Array [
]
error
object
Represents details of an error.
The error code.
The description of the error.
Details for the errors of any parameter value.
fieldErrors
object[]
List of field errors associated with the main error.
Identifies the JSON request field.
The problem associated with the field.
{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
],
"fieldErrors": [
{
"field": "string",
"error": "string"
}
]
}
}
{
"error": {
"code": "5269",
"message": "Entity not found",
"details": [
"The ID(s) specified in the URL do not correspond to the values in the system."
]
}
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
Array [
]
error
object
Represents details of an error.
The error code.
The description of the error.
Details for the errors of any parameter value.
fieldErrors
object[]
List of field errors associated with the main error.
Identifies the JSON request field.
The problem associated with the field.
{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
],
"fieldErrors": [
{
"field": "string",
"error": "string"
}
]
}
}
{
"error": {
"code": "1000",
"message": "Internal Error",
"details": [
"An internal error occurred."
]
}
}