Create beneficiary
curl --request POST \
--url https://api.prod.payana.cloud/public/api/v1/beneficiaries \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"name": "Acme Inc.",
"type": "supplier",
"identifier_type": "NIT",
"identifier_number": "112233449",
"bank_accounts": [
{
"bank_reference": "8b1895e2-5b13-4fa1-9633-382639b6d0e3",
"account_number": "999999999",
"account_type": "savings",
"account_recipient_name": "Acme Inc.",
"account_recipient_document_number": "112233449",
"account_recipient_document_type": "NIT"
}
],
"contact_information": [
{
"type": "email",
"value": "[email protected]"
},
{
"type": "phone",
"value": "+5725706683"
}
]
}
'import requests
url = "https://api.prod.payana.cloud/public/api/v1/beneficiaries"
payload = {
"name": "Acme Inc.",
"type": "supplier",
"identifier_type": "NIT",
"identifier_number": "112233449",
"bank_accounts": [
{
"bank_reference": "8b1895e2-5b13-4fa1-9633-382639b6d0e3",
"account_number": "999999999",
"account_type": "savings",
"account_recipient_name": "Acme Inc.",
"account_recipient_document_number": "112233449",
"account_recipient_document_type": "NIT"
}
],
"contact_information": [
{
"type": "email",
"value": "[email protected]"
},
{
"type": "phone",
"value": "+5725706683"
}
]
}
headers = {
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Acme Inc.',
type: 'supplier',
identifier_type: 'NIT',
identifier_number: '112233449',
bank_accounts: [
{
bank_reference: '8b1895e2-5b13-4fa1-9633-382639b6d0e3',
account_number: '999999999',
account_type: 'savings',
account_recipient_name: 'Acme Inc.',
account_recipient_document_number: '112233449',
account_recipient_document_type: 'NIT'
}
],
contact_information: [
{type: 'email', value: '[email protected]'},
{type: 'phone', value: '+5725706683'}
]
})
};
fetch('https://api.prod.payana.cloud/public/api/v1/beneficiaries', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.prod.payana.cloud/public/api/v1/beneficiaries",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Acme Inc.',
'type' => 'supplier',
'identifier_type' => 'NIT',
'identifier_number' => '112233449',
'bank_accounts' => [
[
'bank_reference' => '8b1895e2-5b13-4fa1-9633-382639b6d0e3',
'account_number' => '999999999',
'account_type' => 'savings',
'account_recipient_name' => 'Acme Inc.',
'account_recipient_document_number' => '112233449',
'account_recipient_document_type' => 'NIT'
]
],
'contact_information' => [
[
'type' => 'email',
'value' => '[email protected]'
],
[
'type' => 'phone',
'value' => '+5725706683'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.prod.payana.cloud/public/api/v1/beneficiaries"
payload := strings.NewReader("{\n \"name\": \"Acme Inc.\",\n \"type\": \"supplier\",\n \"identifier_type\": \"NIT\",\n \"identifier_number\": \"112233449\",\n \"bank_accounts\": [\n {\n \"bank_reference\": \"8b1895e2-5b13-4fa1-9633-382639b6d0e3\",\n \"account_number\": \"999999999\",\n \"account_type\": \"savings\",\n \"account_recipient_name\": \"Acme Inc.\",\n \"account_recipient_document_number\": \"112233449\",\n \"account_recipient_document_type\": \"NIT\"\n }\n ],\n \"contact_information\": [\n {\n \"type\": \"email\",\n \"value\": \"[email protected]\"\n },\n {\n \"type\": \"phone\",\n \"value\": \"+5725706683\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.prod.payana.cloud/public/api/v1/beneficiaries")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Acme Inc.\",\n \"type\": \"supplier\",\n \"identifier_type\": \"NIT\",\n \"identifier_number\": \"112233449\",\n \"bank_accounts\": [\n {\n \"bank_reference\": \"8b1895e2-5b13-4fa1-9633-382639b6d0e3\",\n \"account_number\": \"999999999\",\n \"account_type\": \"savings\",\n \"account_recipient_name\": \"Acme Inc.\",\n \"account_recipient_document_number\": \"112233449\",\n \"account_recipient_document_type\": \"NIT\"\n }\n ],\n \"contact_information\": [\n {\n \"type\": \"email\",\n \"value\": \"[email protected]\"\n },\n {\n \"type\": \"phone\",\n \"value\": \"+5725706683\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prod.payana.cloud/public/api/v1/beneficiaries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Acme Inc.\",\n \"type\": \"supplier\",\n \"identifier_type\": \"NIT\",\n \"identifier_number\": \"112233449\",\n \"bank_accounts\": [\n {\n \"bank_reference\": \"8b1895e2-5b13-4fa1-9633-382639b6d0e3\",\n \"account_number\": \"999999999\",\n \"account_type\": \"savings\",\n \"account_recipient_name\": \"Acme Inc.\",\n \"account_recipient_document_number\": \"112233449\",\n \"account_recipient_document_type\": \"NIT\"\n }\n ],\n \"contact_information\": [\n {\n \"type\": \"email\",\n \"value\": \"[email protected]\"\n },\n {\n \"type\": \"phone\",\n \"value\": \"+5725706683\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"reference": "be07b610-c6f6-465c-8c43-c6469d3a585f",
"name": "Acme Inc.",
"type": "supplier",
"email": "[email protected]",
"phone_number": null,
"identifier_type": "NIT",
"identifier_number": "112233449",
"payment_terms": null,
"fiscal_address": null,
"contact_information": [
{
"type": "email",
"value": "[email protected]"
},
{
"type": "phone",
"value": "+5725706683"
}
],
"bank_accounts": [
{
"reference": "35034bf9-babf-45c1-b9d1-c7267e2e02f0",
"bank_reference": "8b1895e2-5b13-4fa1-9633-382639b6d0e3",
"bank_name": "Banco de Bogotá",
"account_number": "999999999"
}
],
"created_at": "2025-06-01T18:00:35.194+00:00",
"updated_at": "2025-06-01T18:00:35.194+00:00"
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "The request contains invalid data",
"details": {
"amount": [
"Amount must be greater than 0"
],
"beneficiary_id": [
"Beneficiary does not exist"
]
}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "The request contains invalid data",
"details": {
"amount": [
"Amount must be greater than 0"
],
"beneficiary_id": [
"Beneficiary does not exist"
]
}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "The request contains invalid data",
"details": {
"amount": [
"Amount must be greater than 0"
],
"beneficiary_id": [
"Beneficiary does not exist"
]
}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "The request contains invalid data",
"details": {
"amount": [
"Amount must be greater than 0"
],
"beneficiary_id": [
"Beneficiary does not exist"
]
}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "The request contains invalid data",
"details": {
"amount": [
"Amount must be greater than 0"
],
"beneficiary_id": [
"Beneficiary does not exist"
]
}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "The request contains invalid data",
"details": {
"amount": [
"Amount must be greater than 0"
],
"beneficiary_id": [
"Beneficiary does not exist"
]
}
}
}Beneficiaries
Create Beneficiary
Crea un nuevo beneficiario (supplier).
POST
/
beneficiaries
Create beneficiary
curl --request POST \
--url https://api.prod.payana.cloud/public/api/v1/beneficiaries \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"name": "Acme Inc.",
"type": "supplier",
"identifier_type": "NIT",
"identifier_number": "112233449",
"bank_accounts": [
{
"bank_reference": "8b1895e2-5b13-4fa1-9633-382639b6d0e3",
"account_number": "999999999",
"account_type": "savings",
"account_recipient_name": "Acme Inc.",
"account_recipient_document_number": "112233449",
"account_recipient_document_type": "NIT"
}
],
"contact_information": [
{
"type": "email",
"value": "[email protected]"
},
{
"type": "phone",
"value": "+5725706683"
}
]
}
'import requests
url = "https://api.prod.payana.cloud/public/api/v1/beneficiaries"
payload = {
"name": "Acme Inc.",
"type": "supplier",
"identifier_type": "NIT",
"identifier_number": "112233449",
"bank_accounts": [
{
"bank_reference": "8b1895e2-5b13-4fa1-9633-382639b6d0e3",
"account_number": "999999999",
"account_type": "savings",
"account_recipient_name": "Acme Inc.",
"account_recipient_document_number": "112233449",
"account_recipient_document_type": "NIT"
}
],
"contact_information": [
{
"type": "email",
"value": "[email protected]"
},
{
"type": "phone",
"value": "+5725706683"
}
]
}
headers = {
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Acme Inc.',
type: 'supplier',
identifier_type: 'NIT',
identifier_number: '112233449',
bank_accounts: [
{
bank_reference: '8b1895e2-5b13-4fa1-9633-382639b6d0e3',
account_number: '999999999',
account_type: 'savings',
account_recipient_name: 'Acme Inc.',
account_recipient_document_number: '112233449',
account_recipient_document_type: 'NIT'
}
],
contact_information: [
{type: 'email', value: '[email protected]'},
{type: 'phone', value: '+5725706683'}
]
})
};
fetch('https://api.prod.payana.cloud/public/api/v1/beneficiaries', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.prod.payana.cloud/public/api/v1/beneficiaries",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Acme Inc.',
'type' => 'supplier',
'identifier_type' => 'NIT',
'identifier_number' => '112233449',
'bank_accounts' => [
[
'bank_reference' => '8b1895e2-5b13-4fa1-9633-382639b6d0e3',
'account_number' => '999999999',
'account_type' => 'savings',
'account_recipient_name' => 'Acme Inc.',
'account_recipient_document_number' => '112233449',
'account_recipient_document_type' => 'NIT'
]
],
'contact_information' => [
[
'type' => 'email',
'value' => '[email protected]'
],
[
'type' => 'phone',
'value' => '+5725706683'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.prod.payana.cloud/public/api/v1/beneficiaries"
payload := strings.NewReader("{\n \"name\": \"Acme Inc.\",\n \"type\": \"supplier\",\n \"identifier_type\": \"NIT\",\n \"identifier_number\": \"112233449\",\n \"bank_accounts\": [\n {\n \"bank_reference\": \"8b1895e2-5b13-4fa1-9633-382639b6d0e3\",\n \"account_number\": \"999999999\",\n \"account_type\": \"savings\",\n \"account_recipient_name\": \"Acme Inc.\",\n \"account_recipient_document_number\": \"112233449\",\n \"account_recipient_document_type\": \"NIT\"\n }\n ],\n \"contact_information\": [\n {\n \"type\": \"email\",\n \"value\": \"[email protected]\"\n },\n {\n \"type\": \"phone\",\n \"value\": \"+5725706683\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.prod.payana.cloud/public/api/v1/beneficiaries")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Acme Inc.\",\n \"type\": \"supplier\",\n \"identifier_type\": \"NIT\",\n \"identifier_number\": \"112233449\",\n \"bank_accounts\": [\n {\n \"bank_reference\": \"8b1895e2-5b13-4fa1-9633-382639b6d0e3\",\n \"account_number\": \"999999999\",\n \"account_type\": \"savings\",\n \"account_recipient_name\": \"Acme Inc.\",\n \"account_recipient_document_number\": \"112233449\",\n \"account_recipient_document_type\": \"NIT\"\n }\n ],\n \"contact_information\": [\n {\n \"type\": \"email\",\n \"value\": \"[email protected]\"\n },\n {\n \"type\": \"phone\",\n \"value\": \"+5725706683\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prod.payana.cloud/public/api/v1/beneficiaries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Acme Inc.\",\n \"type\": \"supplier\",\n \"identifier_type\": \"NIT\",\n \"identifier_number\": \"112233449\",\n \"bank_accounts\": [\n {\n \"bank_reference\": \"8b1895e2-5b13-4fa1-9633-382639b6d0e3\",\n \"account_number\": \"999999999\",\n \"account_type\": \"savings\",\n \"account_recipient_name\": \"Acme Inc.\",\n \"account_recipient_document_number\": \"112233449\",\n \"account_recipient_document_type\": \"NIT\"\n }\n ],\n \"contact_information\": [\n {\n \"type\": \"email\",\n \"value\": \"[email protected]\"\n },\n {\n \"type\": \"phone\",\n \"value\": \"+5725706683\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"reference": "be07b610-c6f6-465c-8c43-c6469d3a585f",
"name": "Acme Inc.",
"type": "supplier",
"email": "[email protected]",
"phone_number": null,
"identifier_type": "NIT",
"identifier_number": "112233449",
"payment_terms": null,
"fiscal_address": null,
"contact_information": [
{
"type": "email",
"value": "[email protected]"
},
{
"type": "phone",
"value": "+5725706683"
}
],
"bank_accounts": [
{
"reference": "35034bf9-babf-45c1-b9d1-c7267e2e02f0",
"bank_reference": "8b1895e2-5b13-4fa1-9633-382639b6d0e3",
"bank_name": "Banco de Bogotá",
"account_number": "999999999"
}
],
"created_at": "2025-06-01T18:00:35.194+00:00",
"updated_at": "2025-06-01T18:00:35.194+00:00"
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "The request contains invalid data",
"details": {
"amount": [
"Amount must be greater than 0"
],
"beneficiary_id": [
"Beneficiary does not exist"
]
}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "The request contains invalid data",
"details": {
"amount": [
"Amount must be greater than 0"
],
"beneficiary_id": [
"Beneficiary does not exist"
]
}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "The request contains invalid data",
"details": {
"amount": [
"Amount must be greater than 0"
],
"beneficiary_id": [
"Beneficiary does not exist"
]
}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "The request contains invalid data",
"details": {
"amount": [
"Amount must be greater than 0"
],
"beneficiary_id": [
"Beneficiary does not exist"
]
}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "The request contains invalid data",
"details": {
"amount": [
"Amount must be greater than 0"
],
"beneficiary_id": [
"Beneficiary does not exist"
]
}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "The request contains invalid data",
"details": {
"amount": [
"Amount must be greater than 0"
],
"beneficiary_id": [
"Beneficiary does not exist"
]
}
}
}Authorizations
API key provista por Payana.
Body
application/json
Beneficiary payload
Available options:
supplier Tipo de identificación (ej. NIT, CC, RFC).
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Beneficiary created
Available options:
supplier Tipo de identificación (ej. NIT, CC, RFC).
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I