Skip to content

Create agency

This endpoint creates a new agency to be used in the Preloaded Balances flux

POST https://[base_url]/v2/agencies

Body

Request using the POST method

{
    "name": "Agency name",
    "email_for_notifications": "agency@mail.com",
    "phone":"3015106398",
    "country_code":"+57",
    "document_type":"NIT",
    "document_number":"11112222",
    "is_preloaded": true,
    "cobre_account_id":"acc_Px2GxtqCcU"
}

Body parameters

PARAMETER TYPE REQUIRED DESCRIPTION
name String Yes The name of the agency.
email_for_notifications String Yes The email address for receiving notifications.
phone String Yes The phone number of the agency (without country code).
country_code String Yes The country code for the agency's phone number.
document_type String Yes The type of document used by the agency (It must be NIT or CC).
document_number String Yes The agency's unique document number. This number must be unique; if an agency already has the same document number, it will not be created and the existing agency will be returned.
is_preloaded Boolean Yes Send true if the agency is used for Preloaded Balances flux
cobre_account_id String Yes The account ID of the Cobre agency

Endpoint response

{
    "msg": "Agencia creada correctamente",
    "id": 5,
    "agency": {
        "name": "Agencia Colombia",
        "phone": "3015106398",
        "rc_identifier": null,
        "country_code": "+57",
        "oneopay_user_id": null,
        "is_active": true,
        "nuvei_user_id": null,
        "email_for_notifications": "agency@cod.com",
        "document_type": "NIT",
        "created_at": "2025-01-21T15:28:28.759531",
        "document_number": "11112222",
        "id": 5,
        "hyperguest_token": null,
        "updated_at": "2025-01-21T15:28:28.759544",
        "is_archived": false,
        "cobre_account_id":"acc_Px2GxtqCcU"
    }
}