REresolvepay
Payouts

Get a Payout

get/payouts/{payout_id}

Request

Path parameters

payout_idstring required

ID of the Payout

Response

An object representing the created Payout.

idstring

Unique identifier of the Payout.

amount_grossinteger

Total gross amount of all payout transactions

amount_feeinteger

Total fee amount of all payout transactions

amount_netinteger

Total net amount of all payout transactions.

status'pending' | 'in_transit' | 'paid' | 'failed' | 'canceled'

Current status of the Payout. <br><br> pending = the payout is created by Resolve, pending to be sent to our bank. <br> in_transit = the payment or payout has been sent to our bank and is pending their execution. <br> paid = the payment or payout amount was successfully deposited. <br> failed = the payment or payout amount did not successfully deposit. <br> canceled = the payment or payout in Resolve's system was not sent to or executed by the bank. <br>

retry_payout_idstring

Payout id being retried.

failed_atstring

Date time of when the Payout failed.

expected_bystring

Date time of when we expect the Payout to reach the participating entity's bank.

transactions_starting_atstring

This value is the earliest value for payout_transaction.created_at AND payout_transaction.payout_id = payout.id.

transactions_ending_atstring

This value is the latest value for payout_transaction.created_at AND payout_transaction.payout_id = payout.id.

canceled_atstring

Date time of when the Payout was canceled.

created_atstring

Date time of when the Payout was created.

updated_atstring

Date time of when the Payout was last updated.

Example response

{
  "id": "PMMlaE5wbg0",
  "amount_gross": 120,
  "amount_fee": 20,
  "amount_net": 100,
  "status": "pending",
  "retry_payout_id": "PMMlaE5wbg0",
  "failed_at": "2022-09-06T03:08:37.508Z",
  "expected_by": "2022-09-06T03:08:37.508Z",
  "canceled_at": "2022-09-06T03:08:37.508Z",
  "created_at": "2022-09-06T03:08:37.508Z",
  "updated_at": "2022-09-06T03:08:37.508Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.