Caibo PayDocs
Panel

Create a beneficiary

POST
/v1/beneficiaries

Registers who is paid. The same account registered twice for the same customer is the same beneficiary (200 with the existing one). Account details are write-only. The country is the method's when the method has one.

Autorización

apiKey
headerAuthorizationBearer <clave>

Your secret API key, sent as Authorization: Bearer <key>. A key names its environment: psp_test_… works only against sandbox (https://api-sandbox.caibopay.app), psp_live_… only against live (https://api.caibopay.app). Keys are issued by Caibo when your account is opened; the dashboard (Developers) shows the key in use.

Cuerpo de la solicitud

application/json
  1. body
country?string

ISO 3166-1 alpha-2 of the account. Fixed by the method when the method has a country; optional otherwise.

currency*string

The currency the beneficiary receives.

customer_id?string

The id of the customer the account belongs to. Optional.

Match^cus_[0-9a-z]+$
details*

The account details the method requires (see beneficiary_fields in GET /v1/capabilities: for example clabe for spei, routing_number and account_number for ach, a key for pix). Write-only: never returned.

holder?string

The account holder's name. Stored encrypted; descriptive, not part of what makes two registrations the same account.

Longitudlength <= 200
label?string

Your own name for the beneficiary.

Longitudlength <= 100
metadata?

Your own references: at most 20 keys of the form [a-z][a-z0-9_]{0,39}, string values of at most 500 characters. Never personal data.

Camposproperties <= 20
method*string

The method the beneficiary is paid by.

Cuerpo de la respuesta

The request was already made: the existing resource is returned.

application/json
  1. response
country?string

ISO 3166-1 alpha-2 of the account.

created_at*string

When it was created.

Formatodate-time
currency*string

The currency.

customer_id?string

The id of the customer the account belongs to.

Match^cus_[0-9a-z]+$
holder?string

The account holder's name.

id*string

The id of the beneficiary.

Match^ben_[0-9a-z]+$
label?string

Your own name for the beneficiary.

metadata*

Your own references: at most 20 keys of the form [a-z][a-z0-9_]{0,39}, string values of at most 500 characters. Never personal data.

Camposproperties <= 20
method*string

The method.

status*string

active: can be paid. archived: kept for the record and no longer paid.

Valor en"active""archived"
updated_at*string

When it last changed.

Formatodate-time
verification_status*string

What a verification of the account said. verified is final.

Valor en"unverified""verified""failed"
verified_at?string

When it was verified.

Formatodate-time
Ejemplo de solicitud
curl -X POST 'https://api-sandbox.caibopay.app/v1/beneficiaries' \  -H 'Content-Type: application/json' \  -d '{  "currency": "string",  "details": {},  "method": "string"}'
Ejemplo de respuesta
{  "country": "string",  "created_at": "2019-08-24T14:15:22Z",  "currency": "string",  "customer_id": "string",  "holder": "string",  "id": "string",  "label": "string",  "metadata": {    "property1": "string",    "property2": "string"  },  "method": "string",  "status": "active",  "updated_at": "2019-08-24T14:15:22Z",  "verification_status": "unverified",  "verified_at": "2019-08-24T14:15:22Z"}