The GET /recoveries call allows your platform to look up a collection of recoveries. If a merchant's account balance is negative, Recoveries automatically debit a merchant's Payout Method to bring the balance up to $0. Be sure to subscribe to the recoveries.created
Notification event topic in order to programmatically integrate new Recoveries that WePay attempts from the merchant's Payout Method.
previous required | string or null An opaque path for the previous page of results. Perform an HTTP GET to obtain the previous page. |
next required | string or null An opaque path for the next page of results. Perform an HTTP GET to obtain the next page. |
required | Array of objects An array of recovery objects. |
api_version | string |
INVALID_PARAMS
NOT_AUTHORIZED
UNEXPECTED_ERROR
{- "next": null,
- "previous": null,
- "api_version": "3.0",
- "results": [
- {
- "amount": 1000,
- "complete_time": 1278889965,
- "create_time": 1278889543,
- "currency": "USD",
- "custom_data": null,
- "failure_reason": null,
- "id": "bb109170-f401-44b0-8a8b-7abfd27e9f30",
- "owner": {
- "id": "67a88c34-7188-45f2-be1f-6a4fdeb21d77",
- "path": "/accounts/67a88c34-7188-45f2-be1f-6a4fdeb21d77",
- "resource": "accounts"
}, - "path": "/recoveries/bb109170-f401-44b0-8a8b-7abfd27e9f30",
- "payout_method": {
- "id": "00000000-5553-0000-0000-000000000054",
- "path": "/payout_methods/00000000-5553-0000-0000-000000000054",
- "resource": "payout_methods"
}, - "pending_reasons": null,
- "resource": "recoveries",
- "status": "completed",
- "txnr_failure": null,
- "txnr_recovery": {
- "id": "af39bc0e-28ee-4b01-8049-7d04fc6a32c7",
- "path": "/transaction_records/af39bc0e-28ee-4b01-8049-7d04fc6a32c7",
- "resource": "transaction_records"
}, - "api_version": "3.0"
}
]
}