Skip to main content

Get Payout

Use this endpoint to retrieve details of a given payout, i.e. an aggregate of transactions sent from Link Money to your bank account. This is a GET request.

Headers

    Content-Type String - (Required)
    application-json

    Accept String - (Required)
    application-json

    Authorization String - (Required)
    Bearer {ACCESS_TOKEN} (See Authentication)

Parameters

    payoutId String (part of URL) - (Required)
    The specific Payout ID to retrieve

Returns

    payoutId String
    The payout id

    amount Object
    The value as well as the currency of the payout

    payoutStatus enum
    CREATED or AUTHORIZED or SCHEDULED or INITIATED or DISBURSED

    descriptor String
    Appears in the bank statement

    creationDate Date
    The date we the payout was initiated

Get Request

GET - /v1/payouts/PAYOUT_ID
GET Request
1curl --location --request GET '{API_BASE_URL}/v1/payouts/{PAYOUT_ID}' \
2--header 'Content-Type: application/json' \
3--header 'Accept: application/json' \
4--header 'Authorization: Bearer {ACCESS_TOKEN}'

Response Body

Response
1{ 
2	"payoutId": "{PAYOUT_ID}", 
3	"clientReferenceId": "string", 
4	"amount": { 
5		"value": 1, 
6		"currency": "string" 
7	}, 
8	"payoutStatus": "string", 
9	"descriptor": "string", 
10	"creationDate": "2022-05-27T19:39:22.859Z" 
11}