API Documentation
Core Resources
- Webhook
Checkout
- Session
Payments
- Payment Codes
- Payment Links
- Payment Pages
Transfers
Embedded Finance
- Financial Account
Extra Resources
- KYC Verification
- Financial Providers
- Available Countries
Get Payout
curl --request GET \
--url https://api.monime.io/payouts/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Monime-Space-Id: <monime-space-id>'{
"success": true,
"messages": [
"<any>"
],
"result": {
"id": "<string>",
"status": "pending",
"amount": {
"currency": "<string>",
"value": 123
},
"source": {
"financialAccountId": "<string>",
"transactionReference": "<string>"
},
"destination": {
"providerCode": "<string>",
"accountId": "<string>",
"transactionReference": "<string>"
},
"charges": [
{
"name": "<string>",
"amount": {
"currency": "<string>",
"value": 123
},
"metadata": {}
}
],
"delayedReason": "<string>",
"failureDetail": {
"code": "unknown",
"explanation": "<string>"
},
"createTime": "2023-11-07T05:31:56Z",
"metadata": {}
}
}Authorizations
Bearer HTTP authentication specified with the header Authorization: Bearer <access_token>
Headers
The value is the tenancy parameter that Monime used to determine which space the request is intended for.
100Path Parameters
The ID for the payout object to retrieve
Response
Represents the status of the query operation, confirming if it was successful. This field is always true
Contains a list of messages providing relevant information or feedback related to the query or operation
The unique identifier for the payout object
The status of the payout object.
pending, processing, delayed, completed, failed The source of fund for the payout object.
The destination for the fund of the payout object.
The code for the provider as identified by Monime.
The account ID of the account in the provider's ecosystem that the payout amount was disbursed to.
The transaction reference from the provider's ecosystem after the amount was disbursed.
The charges that applied to the payout.
The name of the charge object within Monime.
The amount of the charge that was applied on top of the payout amount.
Further metadata describing the charge object.
The reason when the payout is being delayed.
The detail for the failed status.
The failure code.
unknown, expired, providerUnknown, fundInsufficient, authorizationFailed, providerAccountBlocked, providerAccountMissing, providerAccountQuotaExhausted An explanation of the failure code.
The creation time of the payout object.
This holds key-value pairs, where both the keys and values are strings not exceeding 64 and 100 characters respectively. This allows for flexible and descriptive tagging or additional information to be associated with the object.
Was this page helpful?
curl --request GET \
--url https://api.monime.io/payouts/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Monime-Space-Id: <monime-space-id>'{
"success": true,
"messages": [
"<any>"
],
"result": {
"id": "<string>",
"status": "pending",
"amount": {
"currency": "<string>",
"value": 123
},
"source": {
"financialAccountId": "<string>",
"transactionReference": "<string>"
},
"destination": {
"providerCode": "<string>",
"accountId": "<string>",
"transactionReference": "<string>"
},
"charges": [
{
"name": "<string>",
"amount": {
"currency": "<string>",
"value": 123
},
"metadata": {}
}
],
"delayedReason": "<string>",
"failureDetail": {
"code": "unknown",
"explanation": "<string>"
},
"createTime": "2023-11-07T05:31:56Z",
"metadata": {}
}
}