Get Deposits

GET 
/v2/customers/:customerId/deposits

You can use this API to get the deposits for the customer specified in the request path.

It returns the last 10 deposits by default.

Request

Path Parameters

customerId stringrequired

Id of the customer.

Query Parameters

merchantRefNum string

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.

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.

slipId string

Payment slip

fundingTransactionId string

Funding transaction Id.

Responses

200

OK

application/json

Schema

Schema

deposits 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)

{
  "deposits": [
    {
      "amount": 0,
      "currencyCode": "EUR",
      "paymentInstrumentReference": {
        "id": "1001",
        "instrumentType": "CARD"
      },
      "merchantRefNum": "4bc2deb3-9766-4598-a08e-a98b60615936",
      "returnUrls": [
        {
          "rel": "DEFAULT",
          "href": "https://api.paysafe.com/card/redirect/372b5ee7-6360-4403-b444-164f8f1d2709",
          "method": "GET"
        }
      ],
      "paymentProperties": [
        {
          "key": "CARD_CVV",
          "value": "string"
        }
      ],
      "id": "112233",
      "customerId": "10001",
      "accountId": "2100002",
      "slipId": "5009964049",
      "fundingTransactionId": "500005",
      "creationTime": "2021-07-15T17:54:12Z",
      "expirationTime": "2021-07-15T17:54:12Z",
      "status": "COMPLETED",
      "statusReason": "string",
      "nextStatus": [
        "COMPLETED"
      ],
      "action": "NONE",
      "redirectUrl": {
        "rel": "REDIRECT_PAYMENT",
        "href": "https://api.paysafe.com/card/redirect/372b5ee7-6360-4403-b444-164f8f1d2709",
        "method": "GET"
      },
      "paymentOption": "CARD",
      "refundable": true,
      "paymentDetails": [
        {
          "key": "PAYSAFECASH_BARCODE_TYPE",
          "value": "string"
        }
      ],
      "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
  }
}

PAGO_EFECTIVO

{
  "deposits": [
    {
      "amount": 1000,
      "currencyCode": "PEN",
      "paymentOption": "PAGO_EFECTIVO",
      "merchantRefNum": "a2322550-af91-417f-867e-681efad44b9d",
      "returnUrls": [
        {
          "rel": "ON_COMPLETED",
          "href": "https://api.dev.paysafe.com/checkout/v2/pages/redirect-success.html",
          "method": "GET"
        },
        {
          "rel": "ON_FAILED",
          "href": "https://api.dev.paysafe.com/checkout/v2/pages/redirect-error.html",
          "method": "GET"
        },
        {
          "rel": "DEFAULT",
          "href": "https://api.dev.paysafe.com/checkout/v2/pages/redirect-success.html",
          "method": "GET"
        }
      ],
      "deviceInfo": {
        "threatMetrixSessionId": "a71a475b-1956-4814-9c92-7faa8226b218",
        "appType": "WEB_APP"
      },
      "id": "124567",
      "customerId": "87976765",
      "accountId": "242421231",
      "slipId": "5009964049",
      "fundingTransactionId": "500005",
      "creationTime": "2021-07-15T17:54:12Z",
      "expirationTime": "2021-07-15T17:54:12Z",
      "status": "PENDING",
      "nextStatus": [
        "PROCESSING"
      ]
    }
  ],
  "meta": {
    "numberOfRecords": 1,
    "limit": 10,
    "offset": 0,
    "page": 1
  }
}

Loading...