API Reference
Deposits API
The deposits API allows you to retrieve details of deposits made to your account. When a new deposit is created, a deposit.created webhook event is also delivered.
GET /deposits
Returns a paginated list of all deposits.
Example
curl https://test-api.pinpayments.com/1/deposits -u your-secret-api-key:
200
OK
{
"response": [
{
"token": "dpo_Ts3YECK14zotCTykezRspu",
"amount": "46500",
"currency": "AUD",
"narration": "51746865-000594368 Service NSW Aust Rugby",
"available_at": "2020-01-08T03:10:49Z"
}
],
"count": 1,
"pagination": {
"current": 1,
"previous": null,
"next": null,
"per_page": 25,
"pages": 1,
"count": 1
}
}GET /deposits/deposit-token
Returns the details of a deposit.
Example
curl https://test-api.pinpayments.com/1/deposits/dpo_Ts3YECK14zotCTykezRspu -u your-secret-api-key:
200
OK
{
"response": {
"token": "dpo_Ts3YECK14zotCTykezRspu",
"amount": "46500",
"currency": "AUD",
"narration": "51746865-000594368 Service NSW Aust Rugby",
"available_at": "2020-01-08T03:10:49Z"
}
}Error Responses
| 404 | not_found |
{...}
|
|---|
