Get a Payout Transaction

Request

Security

bearerAuth or basicAuth

Path

payout_transaction_idstringrequired

ID of the Payout Transaction

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

Responses

An object representing the created Payout Transaction.

Bodyapplication/json

idstring

Unique identifier of the payout transactions.

Example:"AOncfxMnm"

payout_idstring

Resolve payout ID.

Example:"gQxGLAowY"

typestring

Type of the payout transaction.

Enum:"advance""payment""refund""monthly_fee""annual_fee""non_advanced_invoice_fee""merchant_payment""mdr_extension""credit_note""express_ach_payout_fee"

Example:"advance"

customer_idstring

Resolve customer ID.

Example:"voArW2nSs"

customer_namestring

Name of the customer.

Example:"Test name"

invoice_idstring

Resolve invoice ID.

Example:"C2vBqxfZ4"

invoice_numberstring

Invoice number identifier.

Example:"R334-097R"

order_idstring

Resolve order ID.

Example:"u5WRraCYY"

po_numberstring

PO number identifier.

Example:"PO-09785"

amount_grossinteger

Payout transaction gross amount.

Example:100

amount_feeinteger

Payout transaction fee amount.

Example:3

amount_netinteger

Payout transaction net amount.

Example:97

created_atstring

Date time of when the payout transaction was created.

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

updated_atstring

Date time of when the payout transaction was last updated.

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

Response

{
  "id": "AOncfxMnm",
  "payout_id": "gQxGLAowY",
  "type": "advance",
  "customer_id": "voArW2nSs",
  "customer_name": "Test name",
  "invoice_id": "C2vBqxfZ4",
  "invoice_number": "R334-097R",
  "order_id": "u5WRraCYY",
  "po_number": "PO-09785",
  "amount_gross": 100,
  "amount_fee": 3,
  "amount_net": 97,
  "created_at": "2022-09-06T03:08:37.508Z",
  "updated_at": "2022-09-06T03:08:37.508Z"
}