WePay logo
      Nothing Found

Get a collection of recoveries

get/recoveries

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.

SecurityappIdAuth and appTokenAuth
Request
query Parameters
page
string

Return elements from this page.

page_size
integer [ 1 .. 50 ]
Default: 10

Return no more than this many elements per page. If not specified, page_size defaults to 10. Maximum value allowed is 50.

create_time_start
integer <int64> >= 0

The timestamp for the start of the search window.

create_time_end
integer <int64> >= 0

The timestamp for the end of the search window.

owner_id
string

Return elements owned by this resource instance.

payout_method_type
string

Payout method used to recover funds.

Enum: Description
payout_bank_ca

Bank account in Canada.

payout_bank_gb

Bank account in the UK (not currently supported).

… 2 more
payout_method_id
string

ID of the payout method used to recover funds.

status
string

Status of the recovery.

Enum: Description
pending

WePay has started processing the recovery, but it is not yet available. Find more details in the pending_reasons structure.

completed

WePay has processed the recovery. Note that a recovery's status can change from completed to failed if the issuing bank rejects the debit.

… 1 more
header Parameters
Api-Version
required
string
Example: 3.0
Unique-Key
string
Responses
200
Response Schema: application/json
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
400

INVALID_PARAMS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples 
Response samples 
application/json
{
  • "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"
      }
    ]
}