v1

latestOpenAPI 3.0.02026-07-26167441.9 MB

List Recipients

get/recipients

Query parameters

limitinteger

Maximum number of recipients to return

offsetinteger

Number of recipients to skip for pagination

national_entity'INDIVIDUAL' | 'ENTITY'

Filter recipients by national entity type

countrystring

Filter recipients by country

Response

List of recipients retrieved successfully

Example response

{
  "data": [
    {
      "id": "3aaa4d82-11e8-48ce-8ef5-04eee3a10802",
      "account_id": "fe14c7c6-c75e-43b7-bdbe-4c87ad52c482",
      "merchant_recipient_id": "MERCHANT_182acf1d-faeb-4ff0-94cd-7fab11b282f6",
      "national_entity": "INDIVIDUAL",
      "entity_type": "PRIVATE",
      "first_name": "Juan",
      "last_name": "Perez",
      "email": "juan.perez@example.com",
      "date_of_birth": "1990-01-15",
      "country": "CO",
      "website": "https://juanperez.com",
      "industry": "Technology",
      "merchant_category_code": "5734",
      "document": {
        "document_number": "1234567890",
        "document_type": "CC"
      },
      "phone": {
        "country_code": "57",
        "number": "3001234567"
      },
      "address": {
        "address_line_1": "Carrera 7 # 32-16",
        "address_line_2": "Oficina 201",
        "city": "Bogota",
        "country": "CO",
        "state": "Cundinamarca",
        "zip_code": "110311",
        "neighborhood": "Centro"
      },
      "legal_representatives": [
        {
          "merchant_reference": "REP_001",
          "first_name": "Maria",
          "last_name": "Gonzalez",
          "email": "maria.gonzalez@example.com",
          "date_of_birth": "1985-05-20",
          "country": "CO",
          "nationality": "CO",
          "title": "CEO",
          "ultimate_beneficial_owner": true,
          "document": {
            "document_type": "CC",
            "document_number": "0987654321"
          },
          "phone": {
            "country_code": "57",
            "number": "3109876543"
          },
          "address": {
            "address_line_1": "Calle 26 # 13-19",
            "country": "CO",
            "state": "Cundinamarca",
            "city": "Bogota",
            "zip_code": "110311"
          }
        }
      ],
      "withdrawal_methods": {
        "bank": {
          "code": "001",
          "branch": "004",
          "branch_digit": "123",
          "account": "1234567890",
          "account_digit": "123",
          "account_type": "SAVINGS",
          "routing": "021000021",
          "country": "CO",
          "currency": "COP"
        }
      },
      "documentation": [
        {
          "file_name": "cc-front.pdf",
          "content_type": "application/pdf",
          "content_category": "IDENTIFICATION",
          "content": "JVBERi0xLjQKJ..."
        }
      ],
      "onboardings": [
        {
          "id": "84c42684-dbe5-4e0f-bd17-4d094e19762d",
          "type": "ONBOARD_ONTO_THE_PROVIDER",
          "workflow": "DIRECT",
          "status": "PENDING",
          "callback_url": "https://merchant.example.com/webhook/onboarding",
          "provider": {
            "id": "ALELO",
            "connection_id": "cc389b51-53a1-4a29-af40-c8cee26c3399"
          },
          "documentation": [
            {
              "file_name": "utility-bill.pdf",
              "content_type": "application/pdf",
              "content_category": "ADDRESS_PROOF",
              "content": "JVBERi0xLjQKJ..."
            }
          ],
          "legal_representatives": [],
          "requirements": [
            {
              "field": "document.cc",
              "message": "Provide CC document image",
              "status": "PENDING"
            }
          ],
          "withdrawal_methods": {
            "bank": {
              "code": "002",
              "branch": "002",
              "account": "9876543210",
              "account_type": "SAVINGS",
              "routing": "021000022",
              "country": "CO",
              "currency": "COP"
            }
          },
          "terms_of_service": {
            "acceptance": true,
            "date": "2025-07-21T20:43:54Z",
            "ip": "129.21.111.11"
          },
          "created_at": "2025-08-27T15:41:19.516982Z",
          "updated_at": "2025-08-27T15:41:19.516989Z"
        }
      ],
      "split_configuration": {
        "calculation_type": "PERCENTAGE",
        "percentage": 10.5,
        "fixed_amount": 5,
        "currency": "USD",
        "rounding_mode": "STANDARD"
      },
      "created_at": "2025-08-27T15:41:19.497413Z",
      "updated_at": "2025-08-27T15:41:19.497425Z"
    }
  ]
}