TeePayDocs
API ReferencePayouts

Get a payout

GET
/v1/disbursements/{reference}

One payout by its TeePay reference. Requires disbursement:read.

Authorization

BearerAuth
headerAuthorizationBearer <token>

Secret API key: tp_test_. or tp_live_.. Server-side only.

Path Parameters

reference*string
Lengthlength <= 128

Response Body

Current payout record

application/json
  1. response
id*string
public_reference?string
operation*unknown
Value in"charge""payout"
status*unknown
Value in"created""pending""processing""succeeded""failed""reversed""refunded"
status_detail?string
money*
created_at*string
Formatdate-time
updated_at*string
Formatdate-time
customer_name?string
customer_phone?string
method?string
channel?string
source?string
fee?
net?
Example Request
curl -X GET 'https://api.teepay.me/v1/disbursements/TP8K2M4QZ1'
Example Response
{  "id": "string",  "public_reference": "string",  "operation": "charge",  "status": "created",  "status_detail": "string",  "money": {    "amount_minor": 0,    "currency": "string"  },  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "customer_name": "string",  "customer_phone": "string",  "method": "string",  "channel": "string",  "source": "string",  "fee": {    "amount_minor": 0,    "currency": "string"  },  "net": {    "amount_minor": 0,    "currency": "string"  }}

Create a payout POST

Confirms a valid quote and sends the payout. Your balance is reserved for the amount plus the fee before the payout is sent. If the outcome is uncertain (202), read the payout and never retry with a new idempotency_key. Requires disbursement:create.

List payouts GET

Your account's payouts, newest first. Requires disbursement:read.