Skip to content
Merchant API/
/
Get a Payout

Get a Payout

Request

Security
bearerAuth or basicAuth
Path
payout_idstringrequired

ID of the Payout

curl -i -X GET \
  'https://docs.resolvepay.com/_mock/merchant-api/openapi/payouts/{payout_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

An object representing the created Payout.

Bodyapplication/json
idstring

Unique identifier of the Payout.

Example:"PMMlaE5wbg0"
amount_grossinteger

Total gross amount of all payout transactions

Example:120
amount_feeinteger

Total fee amount of all payout transactions

Example:20
amount_netinteger

Total net amount of all payout transactions.

Example:100
statusstring

Current status of the Payout.

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

Enum:"pending""in_transit""paid""failed""canceled"
Example:"pending"
retry_payout_idstring

Payout id being retried.

Example:"PMMlaE5wbg0"
failed_atstring

Date time of when the Payout failed.

Example:"2022-09-06T03:08:37.508Z"
expected_bystring

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

Example:"2022-09-06T03:08:37.508Z"
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.

Example:"2022-09-06T03:08:37.508Z"
created_atstring

Date time of when the Payout was created.

Example:"2022-09-06T03:08:37.508Z"
updated_atstring

Date time of when the Payout was last updated.

Example:"2022-09-06T03:08:37.508Z"
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",
  "transactions_starting_at": "string",
  "transactions_ending_at": "string",
  "canceled_at": "2022-09-06T03:08:37.508Z",
  "created_at": "2022-09-06T03:08:37.508Z",
  "updated_at": "2022-09-06T03:08:37.508Z"
}