Skip to main content
POST
Create beneficiary

Authorizations

api-key
string
header
required

API key provista por Payana.

Body

application/json

Beneficiary payload

type
enum<string>
required
Available options:
supplier
identifier_number
string
required
name
string
required
identifier_type
string | null

Tipo de identificación (ej. NIT, CC, RFC).

email
string | null
phone_number
string | null
payment_terms
integer | null
contact_information
object[]
bank_accounts
object[]

Response

Beneficiary created

reference
string
required
name
string
required
identifier_number
string
required
type
enum<string>
Available options:
supplier
email
string | null
phone_number
string | null
identifier_type
string | null

Tipo de identificación (ej. NIT, CC, RFC).

payment_terms
integer | null
fiscal_address
object | null
contact_information
object[]
bank_accounts
object[]
created_at
string<date-time> | null
updated_at
string<date-time> | null