Saltar al contenido principal
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"
}

Parámetros

payout-id
string
requerido
El ID del payout devuelto al crear el payout

Respuesta

success
boolean
Indica si la operación fue exitosa.
id
string
El identificador único del payout.
onBehalfOf
string
El identificador del usuario o entidad en cuyo nombre se realiza el payout.
companyId
string
El identificador de la empresa asociada a este payout.
status
string
El estado actual del payout. Valores posibles: created, processing, completed, failed, cancelled.
amount
number
El monto en la moneda de origen.
source
object
Detalles del pago de origen
destination
object
Detalles del pago de destino. La estructura depende del tipo de destino.
deductFromBalance
boolean
Indica si el monto se descontó del saldo de la cuenta.
quoteId
string
El ID de cotización usado para el cálculo del tipo de cambio (si se proporcionó).
createdAt
string
La fecha y hora (ISO 8601) de cuándo se creó el payout.
completedAt
string
La fecha y hora (ISO 8601) de cuándo se completó el payout (presente solo si el estado es completed).
failedAt
string
La fecha y hora (ISO 8601) de cuándo falló el payout (presente solo si el estado es failed).
failureReason
string
El motivo de la falla (presente solo si el estado es 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"
}

Respuestas de error

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