Get Payout Details

Return an aggregated breakdown of the money movements included in the payout along with details of the disbursement itself.

SecurityMarketplace API Key | Merchant Secret Token | Admin JWT | Merchant JWT | Marketplace JWT

Request

path Parameters

payoutId

required

string

Responses

200

400

401

403

404

405

406

409

422

429

500

503

get/transactions/payouts/{payoutId}

Request samples

Curl
JavaScript

Response samples

application/json

{"summary": {"payoutId": "payout_aG2QcrJhN35DB7Jx",
"referencePayoutId": "string",
"currency": "string",
"settlementDate": "2019-08-24",
"merchantId": "mcht_aG2QcrJhN35DB7Jl",
"merchantBusinessName": "string",
"amount": 0,
"openingBalance": 0,
"closingBalance": 0,
"totalAmount": 0,
"status": "paid",
"bankAccountNumber": "string",
"paymentChannel": "direct_entry",
"statementDescriptor": "string",
"createdAt": "2019-08-24T14:15:22Z"
},
"summaryLineItems": [{"entryType": "Payment",
"count": 0,
"totalAmount": 0
}
],
"accountDetails": {"accountId": "xacc_aG2Qc7JhN35DB7J5",
"accountName": "string",
"bankName": "string",
"identifier": {"AuBankAccountIdentifier": {"bsb": "string",
"accountNumber": "string"
}
},
"currency": "AUD",
"country": "string"
}
}