Skip to main content
GET
/
v1
/
payment-requirements
Payment corridor requirements
curl --request GET \
  --url https://api.cadanapay.com/v1/payment-requirements \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.cadanapay.com/v1/payment-requirements"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.cadanapay.com/v1/payment-requirements', 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.cadanapay.com/v1/payment-requirements",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.cadanapay.com/v1/payment-requirements"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.cadanapay.com/v1/payment-requirements")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.cadanapay.com/v1/payment-requirements")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api.cadana.com/schemas/paymentDetails.bank.CO.json",
  "title": "Colombia - bank payment details",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "accountName",
    "accountNumber",
    "bankCode",
    "bankName",
    "accountType",
    "beneficiaryId",
    "address",
    "email"
  ],
  "properties": {
    "accountName": {
      "type": "string",
      "maxLength": 60
    },
    "accountNumber": {
      "type": "string",
      "pattern": "^[0-9]{9,16}$",
      "description": "9-16-digit Colombian account number"
    },
    "bankCode": {
      "type": "string",
      "pattern": "^[A-Za-z0-9]{1,11}$",
      "description": "1-11 alphanumeric bank code"
    },
    "accountType": {
      "type": "string",
      "enum": [
        "Checking",
        "Saving"
      ]
    },
    "email": {
      "type": "string",
      "format": "email",
      "maxLength": 100
    },
    "beneficiaryId": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "type",
        "value"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "NIT",
            "CC",
            "CE",
            "TI",
            "PASS"
          ]
        },
        "value": {
          "type": "string"
        }
      },
      "allOf": [
        {
          "if": {
            "properties": {
              "type": {
                "const": "NIT"
              }
            }
          },
          "then": {
            "properties": {
              "value": {
                "pattern": "^\\d{9,11}$"
              }
            }
          }
        },
        {
          "if": {
            "properties": {
              "type": {
                "const": "CC"
              }
            }
          },
          "then": {
            "properties": {
              "value": {
                "pattern": "^\\d{6,10}$"
              }
            }
          }
        }
      ]
    },
    "address": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "line1",
        "city",
        "countryCode"
      ],
      "properties": {
        "line1": {
          "type": "string",
          "maxLength": 70
        },
        "city": {
          "type": "string",
          "maxLength": 50
        },
        "countryCode": {
          "const": "CO"
        }
      }
    }
  }
}
{
"code": "invalid_request_body",
"message": "The request body provided is not valid",
"params": {
"field": "Value is invalid."
}
}
{
"code": "resource_not_found",
"message": "Requested resource could not be found."
}
{
"code": "internal_error",
"message": "An unexpected error occurred. Please try again later."
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-MultiTenantKey
string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Query Parameters

countryCode
string
required
Example:

"CO"

paymentMethod
string
required
Example:

"bank"

currency
string
required
Example:

"COP"

Response

Draft-07 JSON-Schema fragment

This is a Draft-07 JSON Schema fragment. For the full meta-schema, see https://json-schema.org/draft-07/schema#. Rely on the provided example for the expected structure.