Get Withdrawals
GET/v2/customers/:customerId/withdrawals
You can use this API to get the withdrawals for the current customer.
It returns the last 10 withdrwals by default.
Request
Path Parameters
Customer Id.
Query Parameters
Possible values: <= 255 characters
This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request and allows cross referencing objects from merchant system.
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.
Payment slip
Responses
- 200
- 405
OK
- application/json
- Schema
- Example (from schema)
- US_BANK_ACCOUNT_WITHDRAWAL
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.
{
"withdrawals": [
{
"amount": 1000,
"currencyCode": "EUR",
"paymentInstrumentReference": {
"id": "1001",
"instrumentType": "CARD"
},
"merchantRefNum": "4bc2deb3-9766-4598-a08e-a98b60615936",
"paymentProperties": [
{
"key": "CARD_CVV",
"value": "string"
}
],
"id": "5000000123",
"accountId": "1000000123",
"customerId": "2000000123",
"slipId": "5009964049",
"fundingTransactionId": "544232",
"creationTime": "2021-07-15T17:54:12Z",
"expirationTime": "2021-07-15T17:54:12Z",
"status": "COMPLETED",
"statusReason": "string",
"nextStatus": [
"COMPLETED"
],
"action": "NONE",
"scaDetails": {
"eventId": "06bdcd2c-0cce-4b36-97ec-281c8f5d743c",
"walletOperationId": "a5865fd6-18c2-45a8-9953-1c00eac36c36",
"authenticationMode": "OUTSOURCED",
"availableVerifications": [
{
"method": "OTP",
"channel": "SMS",
"target": "jo***@example.com"
}
],
"creationTime": "2021-07-15T17:54:12Z",
"expirationTime": "2021-07-15T17:54:12Z"
},
"paymentOption": "CARD",
"paymentDetails": [
{
"key": "PAYSAFECASH_BARCODE_TYPE",
"value": "string"
}
],
"type": "FIRST_PARTY",
"description": "string",
"recipientReference": "97266b06-c85f-4acd-9a3f-3aa0eed8b11e",
"fees": [
{
"amount": 1000,
"currency": "EUR",
"paymentReason": "OTHER_FEE",
"merchantId": "500005",
"recipientCurrency": "EUR",
"merchantAccountId": "100001",
"fxAmount": {
"amount": 0,
"rate": 0,
"currency": "EUR"
}
}
]
}
],
"meta": {
"numberOfRecords": 1,
"limit": 10,
"offset": 0,
"page": 1
}
}
{
"withdrawals": [
{
"amount": 1000,
"currencyCode": "USD",
"paymentOption": "BANK_TRANSFER",
"paymentInstrumentReference": {
"id": "12345",
"instrumentType": "US_BANK_ACCOUNT"
},
"id": "124567",
"accountId": "5009964049",
"customerId": "500014306996",
"creationTime": "2021-07-15T17:54:12Z",
"expirationTime": "2021-07-15T18:54:12Z",
"fee": 100,
"fees": [
{
"amount": 100,
"currency": "USD",
"paymentReason": "MERCHANT_FEE"
}
],
"fundingTransactionId": "544232",
"slipId": "5009964049",
"status": "COMPLETED"
}
],
"meta": {
"numberOfRecords": 1,
"limit": 1,
"page": 1
}
}
Method Not Allowed
- application/json
- Schema
- Example (from schema)
- DW-OPERATION-NOT-ALLOWED
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": "DW-OPERATION-NOT-ALLOWED",
"message": "Operation is not allowed in your account. Contact Paysafe for further details.",
"details": [
"Operation is not allowed in your account. Contact Paysafe for further details."
]
}
}