REresolvepay
Payout Transactions

Get a Payout Transaction

get/payout_transactions/{payout_transaction_id}

Request

Path parameters

payout_transaction_idstring required

ID of the Payout Transaction

Response

An object representing the created Payout Transaction.

idstring

Unique identifier of the payout transaction.

merchant_idstring

ID of the sub-merchant or partner this payout transaction belongs to.

payout_idstring

Resolve payout ID.

type'advance' | 'payment' | 'refund' | 'monthly_fee' | 'annual_fee' | 'non_advanced_invoice_fee' | 'merchant_payment' | 'mdr_extension' | 'credit_note' | 'express_ach_payout_fee' | 'express_ach_payment_fee' | 'mdr_passthrough'

Type of the payout transaction.

customer_idstring

Resolve customer ID.

customer_namestring

Name of the customer.

invoice_idstring

Resolve invoice ID.

invoice_numberstring

Invoice number identifier.

order_idstring

Resolve order ID.

po_numberstring

PO number identifier.

amount_grossinteger

Payout transaction gross amount.

amount_feeinteger

Payout transaction fee amount.

amount_netinteger

Payout transaction net amount.

created_atstring

Date time of when the payout transaction was created.

updated_atstring

Date time of when the payout transaction was last updated.

Example response

{
  "id": "AOncfxMnm",
  "merchant_id": "MER456789",
  "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"
}

Changes

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