Skip to main content
GET
/
v1
/
payouts
/
:payout-id
curl --location --request GET 'https://stablecoin-api.sandbox.getmeru.com/v1/payouts/3ddd0e5b-6276-4b48-b756-c1fcc9a2efd1' \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>'

{
  "success": true,
  "id": "3ddd0e5b-6276-4b48-b756-c1fcc9a2efd1",
  "onBehalfOf": "123",
  "companyId": "123",
  "status": "completed",
  "amount": 1000,
  "source": {
    "paymentRail": "stellar",
    "currency": "usdc",
    "address": "123123"
  },
  "destination": {
    "type": "bank",
    "currency": "cop",
    "details": {
      "country": "CO",
      "accountType": "savings",
      "bankAccountNumber": "1234567890",
      "bankCode": "876",
      "beneficiary": {
        "email": "beneficiary@example.com",
        "documentType": "CC",
        "documentNumber": "12345678",
        "firstName": "John",
        "lastName": "Doe",
        "phone": "+573001234567",
        "city": "Bogotá",
        "state": "Cundinamarca",
        "address": "Calle 123 #45-67",
        "country": "CO",
        "type": "individual"
      }
    }
  },
  "deductFromBalance": true,
  "quoteId": "efaaf971-6d8b-4f36-be36-187c9f68fc06",
  "createdAt": "2024-01-15T10:00:00Z",
  "completedAt": "2024-01-15T10:25:00Z"
}

​
Params

​
payout-id
string
required
The payout ID returned when creating the payout

​
Response

​
success
boolean
Indicates whether the call was successful.
​
id
string
The unique payout identifier.
​
onBehalfOf
string
The identifier of the user or entity on whose behalf the payout is being made.
​
companyId
string
The company identifier associated with this payout.
​
status
string
The current status of the payout. Possible values: created, processing, completed, failed, cancelled.
​
amount
number
The amount in the source currency.
​
source
object
Source payment details
​
destination
object
Destination payment details. The structure depends on the destination type.
​
deductFromBalance
boolean
Whether the amount was deducted from the account balance.
​
quoteId
string
The quote ID used for exchange rate calculation (if provided).
​
createdAt
string
The ISO 8601 timestamp when the payout was created.
​
completedAt
string
The ISO 8601 timestamp when the payout was completed (only present if status is completed).
​
failedAt
string
The ISO 8601 timestamp when the payout failed (only present if status is failed).
​
failureReason
string
The reason for failure (only present if status is failed).
curl --location --request GET 'https://stablecoin-api.sandbox.getmeru.com/v1/payouts/3ddd0e5b-6276-4b48-b756-c1fcc9a2efd1' \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>'

{
  "success": true,
  "id": "3ddd0e5b-6276-4b48-b756-c1fcc9a2efd1",
  "onBehalfOf": "123",
  "companyId": "123",
  "status": "completed",
  "amount": 1000,
  "source": {
    "paymentRail": "stellar",
    "currency": "usdc",
    "address": "123123"
  },
  "destination": {
    "type": "bank",
    "currency": "cop",
    "details": {
      "country": "CO",
      "accountType": "savings",
      "bankAccountNumber": "1234567890",
      "bankCode": "876",
      "beneficiary": {
        "email": "beneficiary@example.com",
        "documentType": "CC",
        "documentNumber": "12345678",
        "firstName": "John",
        "lastName": "Doe",
        "phone": "+573001234567",
        "city": "Bogotá",
        "state": "Cundinamarca",
        "address": "Calle 123 #45-67",
        "country": "CO",
        "type": "individual"
      }
    }
  },
  "deductFromBalance": true,
  "quoteId": "efaaf971-6d8b-4f36-be36-187c9f68fc06",
  "createdAt": "2024-01-15T10:00:00Z",
  "completedAt": "2024-01-15T10:25:00Z"
}

​
Error Responses

{
  "success": false,
  "error": "Unauthorized. Please check your authentication credentials."
}