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>'
{
  "$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"
        }
      }
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.cadanapay.com/llms.txt

Use this file to discover all available pages before exploring further.

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.