Payout Target schema

string

Unique identifier for this Payout Target.

Example:

"01HPR8S7YF43PV3QV16TZDC80P"

reference

string

Reference sent in by merchant to identify Payout Target.

description

string

An extra metadata field that can be included for visibility.

customerId

string

Reference to customer who owns this Payout Target.

Example:

"01HPR57X6QR5ZRKEEKBSDBW4RA"

customerDetails

object

Details about the customer who owns this Payout Target.

status

enum<string>

Status of the Payout Target.

Available options:

active,

cancelled

Example:

"active"

statusMessage

enum<string>

Additional detail on the status. Only present when status is "cancelled".

Available options:

AUTHENTICATION_FAILED,

CUSTOMER_CANCELLATION,

DECLINED_BY_BANK,

EXPIRED,

INVALID_ACCOUNT,

NOT_ENOUGH_FUNDS,

ERROR

authUrl

string

URL where the customer should be redirected to complete the Payout Target verification.

redirectUrl

string

URL where the customer will be redirected after completing the Payout Target verification.

type

enum<string>

Type of Payout Target created.

Available options:

bankAccount

createdAt

string

ISO string indicating when the Payout Target was created.

updatedAt

string

ISO string indicating when the Payout Target was last updated.

Get Payin Request Status

{
  "id": "01HPR8S7YF43PV3QV16TZDC80P",
  "reference": "<string>",
  "description": "<string>",
  "customerId": "01HPR57X6QR5ZRKEEKBSDBW4RA",
  "customerDetails": {
    "reference": "<string>",
    "name": "Pepito Perez",
    "documentType": "cc",
    "documentNumber": "1037551022",
    "email": "pepito@gmail.com",
    "phoneNumber": "3013111111"
  },
  "status": "active",
  "statusMessage": "AUTHENTICATION_FAILED",
  "authUrl": "<string>",
  "redirectUrl": "<string>",
  "type": "bankAccount",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Introduction

API Documentation

Webhooks

Payout Target schema