WePay logo
      Nothing Found

Get a collection of payouts

get/payouts

The GET /payouts call allows your platform to look up a collection of payouts. Payouts allow your merchants to receive their funds from your platform.

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 receive payout.

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 receive payout.

status
string

Status of the payout.

Enum: Description
pending

WePay is currently processing this payout. See the pending_reasons structure for additional information.

completed

WePay has finished processing this payout. Note: Other bank institutions must also process payouts to bank accounts before the merchant will see the deposit in their account.

… 1 more
reference_id
string

A custom reference ID for your platform to track payouts. It can be any string.

header Parameters
Api-Version
required
string
Example: 3.0
Unique-Key
string
Responses
200
Response Schema: application/json
required
Array of objects unique

An array of payout objects.

next
required
string or null

An opaque path for the next page of results. Perform an HTTP GET to obtain the next page.

previous
required
string or null

An opaque path for the previous page of results. Perform an HTTP GET to obtain the previous page.

api_version
string
400

INVALID_PARAMS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples 
Response samples 
application/json
{
  • "next": "/payouts?page=QVFQNUFBRVhENUVGdEFOTk1CVzR4bHVsMnR2WGRJVkpVUVJtQTNvZXZlYVM2b1dDMGIvSXBDenEwTWlNRW9KbXpaTkJOVytaWjlHTEZNYVdPbU5Ka093MEhwSjcxZll4ZC9KM2dCWURlK29rS2pRZVZUNm43YzY0eUZJdkc5Q0dGd0RENSsyNE4rUFA1Wm5HUk15OXhrbFhhYnpEaklicVMxM1JrTmg1M1EvaEVZMEptdEdPZ01jcXhWM09QUT09",
  • "previous": null,
  • "api_version": "3.0",
  • "results": [
    • {
      • "amount": 941,
      • "complete_time": 1510128604,
      • "create_time": 1510128004,
      • "currency": "USD",
      • "custom_data": null,
      • "failure_reason": null,
      • "id": "00000000-0000-0000-0000-00000a51d642",
      • "owner": {
        • "id": "be2b42e5-b808-40ae-9bbe-3291ab493f57",
        • "path": "/accounts/be2b42e5-b808-40ae-9bbe-3291ab493f57",
        • "resource": "accounts"
        },
      • "path": "/payouts/00000000-0000-0000-0000-00000a51d642",
      • "payout_method": {
        • "id": "00000000-6261-5553-0000-000000000bf2",
        • "path": "/payout_methods/00000000-6261-5553-0000-000000000bf2",
        • "resource": "payout_methods"
        },
      • "pending_reasons": null,
      • "resource": "payouts",
      • "status": "completed",
      • "txnr_failure": null,
      • "txnr_payout": {
        • "id": "00000000-0000-0000-0000-000000013003",
        • "path": "/transaction_records/00000000-0000-0000-0000-000000013003",
        • "resource": "transaction_records"
        },
      • "api_version": "3.0"
      },
    • {
      • "amount": 643,
      • "complete_time": null,
      • "create_time": 1510125026,
      • "currency": "USD",
      • "custom_data": null,
      • "failure_reason": null,
      • "id": "00000000-0000-0000-0000-00000d37a696",
      • "owner": {
        • "id": "be2b42e5-b808-40ae-9bbe-3291ab493f57",
        • "path": "/accounts/be2b42e5-b808-40ae-9bbe-3291ab493f57",
        • "resource": "accounts"
        },
      • "path": "/payouts/00000000-0000-0000-0000-00000d37a696",
      • "payout_method": {
        • "id": "00000000-6261-5553-0000-000000000ad1",
        • "path": "/payout_methods/00000000-6261-5553-0000-000000000ad1",
        • "resource": "payout_methods"
        },
      • "pending_reasons": [
        • {
          • "details": null,
          • "reason_code": "REVIEW",
          • "reason_message": "Payout is under review."
          }
        ],
      • "resource": "payouts",
      • "status": "pending",
      • "txnr_failure": null,
      • "txnr_payout": null,
      • "api_version": "3.0"
      }
    ]
}