Payout Request schema

{
  "id": "01HPR8QBF5QKA313RPBSKYB7DS",
  "reference": "<string>",
  "customerId": "01HPR57X6QR5ZRKEEKBSDBW4RA",
  "customerDetails": {
    "reference": "<string>",
    "name": "Pepito Perez",
    "documentType": "cc",
    "documentNumber": "1037551022",
    "email": "[email protected]",
    "phoneNumber": "3013111111"
  },
  "payoutTargetId": "01HPR8S7YF43PV3QV16TZDC80P",
  "payoutTargetDetails": {
    "reference": "<string>",
    "description": "<string>",
    "type": "bankAccount"
  },
  "status": "processing",
  "statusMessage": "AUTHENTICATION_FAILED",
  "amount": 100000,
  "amountSent": 100000,
  "fee": 500,
  "sourceMerchantAccountId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

string

Example:

reference

string

customerId

string

Example:

customerDetails

object

Show child attributes

payoutTargetId

string

Example:

payoutTargetDetails

object

Show child attributes

status

enum<string>

Available options:

processing,

approved,

cancelled

statusMessage

enum<string>

Available options:

AUTHENTICATION_FAILED,

CUSTOMER_CANCELLATION,

DECLINED_BY_BANK,

EXPIRED,

INVALID_ACCOUNT,

NOT_ENOUGH_FUNDS,

ERROR

amount

number

Example:

amountSent

number

Example:

fee

number

Example:

sourceMerchantAccountId

string

createdAt

string<date-time>

updatedAt

string<date-time>

Get Payout Target Status

⌘I

Introduction

API Documentation

Webhooks

Payout Request schema