RevoluPAY Agent API (1.0.0)

Download OpenAPI specification:

License: Apache 2.0

API para agentes que gestionan compañías en RevoluPAY. Requiere autenticación por API Key y expone operaciones para crear/modificar compañías, gestionar documentos, listar/consultar, iniciar login OTP de empresa y crear órdenes TPV usando el token de sesión emitido por dicho login.

login

Returns authentication object that contains valid token for the rest of the API calls.

Returns authentication object that contains valid token for the rest of the API calls.

Authorizations:
api_key
header Parameters
x-api-key
required
string

API Key del agente

rv-authorization
required
string

Base64 encode de user:password para la aplicación

Responses

Response samples

Content type
application/json
{
  • "message": {
    }
}

company

Operaciones sobre compañías gestionadas por el agente

Crea una compañía (entorno prod)

Crea un usuario titular y la compañía asociada bajo el agente autenticado.

Authorizations:
api_key
header Parameters
x-api-key
required
string

API Key del agente

RV-SESS-TOKEN
required
string

Token de sesión obtenido tras login

Request Body schema: application/json
required
company_name
required
string
core_kyb_profile_type_client
required
string
Enum: "PYME_PRIVATE_COMPANY" "PYME_PUBLIC_COMPANY" "PYME_MIXED_COMPANY" "COMPANIES_PRIVATE_COMPANY" "COMPANIES_PUBLIC_COMPANY" "COMPANIES_MIXED_COMPANY"

Tipo de cliente (catálogo interno)

registration_number
required
string
address_country
required
string

ISO2

address_city
required
string
address_province
required
string
address_zip_code
required
string
address_street_name
required
string
address_line
string
bank_name
required
string
bank_phone
required
string
account_number
required
string
routing_number
string
swift
string
iban
string
bank_address_country
required
string
bank_address_city
required
string
bank_address_province
required
string
bank_address_zip_code
required
string
bank_address_street_name
required
string
bank_address_line
string
first_name
required
string
last_name
required
string
email
required
string <email>
phone
required
string
language
required
string
Enum: "english" "spanish"
password
required
string <password>
password_repeat
required
string <password>
objective_operation
required
string

Responses

Request samples

Content type
application/json
{
  • "company_name": "Test Company from Agent 9",
  • "core_kyb_profile_type_client": "COMPANIES_PRIVATE_COMPANY",
  • "registration_number": "0000XXXXXX",
  • "address_country": "US",
  • "address_city": "address_city",
  • "address_province": "address_province",
  • "address_zip_code": "address_zip_code",
  • "address_street_name": "address_street_name",
  • "address_line": "",
  • "bank_name": "bank_name",
  • "bank_phone": "+34660000000",
  • "account_number": "account_number",
  • "routing_number": "",
  • "swift": "",
  • "iban": "",
  • "bank_address_country": "US",
  • "bank_address_city": "bank_address_city",
  • "bank_address_province": "bank_address_province",
  • "bank_address_zip_code": "bank_address_zip_code",
  • "bank_address_street_name": "bank_address_street_name",
  • "bank_address_line": "",
  • "first_name": "first_name",
  • "last_name": "last_name",
  • "email": "company9_for_agent@revolupay.es",
  • "phone": "+34660000000",
  • "language": "spanish",
  • "password": "**************",
  • "password_repeat": "**************",
  • "objective_operation": "objective_operation"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success",
  • "result": {
    }
}

Crea una compañía indicando el idioma

Igual que /create_company, permitiendo fijar el idioma de notificaciones ('english'|'spanish').

Authorizations:
api_key
path Parameters
language
required
string
Default: "english"
Enum: "english" "spanish"
header Parameters
x-api-key
required
string

API Key del agente

RV-SESS-TOKEN
required
string

Token de sesión obtenido tras login

Request Body schema: application/json
required
company_name
required
string
core_kyb_profile_type_client
required
string
Enum: "PYME_PRIVATE_COMPANY" "PYME_PUBLIC_COMPANY" "PYME_MIXED_COMPANY" "COMPANIES_PRIVATE_COMPANY" "COMPANIES_PUBLIC_COMPANY" "COMPANIES_MIXED_COMPANY"

Tipo de cliente (catálogo interno)

registration_number
required
string
address_country
required
string

ISO2

address_city
required
string
address_province
required
string
address_zip_code
required
string
address_street_name
required
string
address_line
string
bank_name
required
string
bank_phone
required
string
account_number
required
string
routing_number
string
swift
string
iban
string
bank_address_country
required
string
bank_address_city
required
string
bank_address_province
required
string
bank_address_zip_code
required
string
bank_address_street_name
required
string
bank_address_line
string
first_name
required
string
last_name
required
string
email
required
string <email>
phone
required
string
language
required
string
Enum: "english" "spanish"
password
required
string <password>
password_repeat
required
string <password>
objective_operation
required
string

Responses

Request samples

Content type
application/json
{
  • "company_name": "Test Company from Agent 9",
  • "core_kyb_profile_type_client": "COMPANIES_PRIVATE_COMPANY",
  • "registration_number": "0000XXXXXX",
  • "address_country": "US",
  • "address_city": "address_city",
  • "address_province": "address_province",
  • "address_zip_code": "address_zip_code",
  • "address_street_name": "address_street_name",
  • "address_line": "",
  • "bank_name": "bank_name",
  • "bank_phone": "+34660000000",
  • "account_number": "account_number",
  • "routing_number": "",
  • "swift": "",
  • "iban": "",
  • "bank_address_country": "US",
  • "bank_address_city": "bank_address_city",
  • "bank_address_province": "bank_address_province",
  • "bank_address_zip_code": "bank_address_zip_code",
  • "bank_address_street_name": "bank_address_street_name",
  • "bank_address_line": "",
  • "first_name": "first_name",
  • "last_name": "last_name",
  • "email": "company9_for_agent@revolupay.es",
  • "phone": "+34660000000",
  • "language": "spanish",
  • "password": "**************",
  • "password_repeat": "**************",
  • "objective_operation": "objective_operation"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success",
  • "result": {
    }
}

Modifica datos de una compañía (solo estado PENDIENTE)

Authorizations:
api_key
Request Body schema: application/json
required
id
required
integer
company_name
string
registration_number
string
address_country
string
address_city
string
address_province
string
address_zip_code
string
address_street_name
string
bank_name
string
bank_phone
string
account_number
string
bank_address_country
string
bank_address_city
string
bank_address_province
string
bank_address_zip_code
string
bank_address_street_name
string
objective_operation
string

Responses

Request samples

Content type
application/json
{
  • "id": 162,
  • "company_name": "Test Company from Agent 9. mod",
  • "core_kyb_profile_type_client": "COMPANIES_PRIVATE_COMPANY",
  • "registration_number": "0000XXXXXX. mod",
  • "address_country": "IT",
  • "address_city": "address_city. mod",
  • "address_province": "address_province. mod",
  • "address_zip_code": "address_zip_code. mod",
  • "address_street_name": "address_street_name. mod",
  • "address_line": ". mod",
  • "bank_name": "bank_name. mod",
  • "bank_phone": "+34660000001",
  • "account_number": "account_number. mod",
  • "routing_number": ". mod",
  • "swift": ". mod",
  • "iban": ". mod",
  • "bank_address_country": "IT",
  • "bank_address_city": "bank_address_city. mod",
  • "bank_address_province": "bank_address_province. mod",
  • "bank_address_zip_code": "bank_address_zip_code. mod",
  • "bank_address_street_name": "bank_address_street_name. mod",
  • "bank_address_line": ". mod",
  • "first_name": "first_name. mod",
  • "last_name": "last_name. mod",
  • "email": "company10_for_agent@revolupay.es",
  • "phone": "+34660000002",
  • "language": "english",
  • "password": "*************1",
  • "password_repeat": "*************1",
  • "objective_operation": "objective_operation. mod"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success",
  • "result": {
    }
}

Modifica datos de una compañía indicando idioma

Authorizations:
api_key
path Parameters
language
required
string
Default: "english"
Enum: "english" "spanish"
Request Body schema: application/json
required
id
required
integer
company_name
string
registration_number
string
address_country
string
address_city
string
address_province
string
address_zip_code
string
address_street_name
string
bank_name
string
bank_phone
string
account_number
string
bank_address_country
string
bank_address_city
string
bank_address_province
string
bank_address_zip_code
string
bank_address_street_name
string
objective_operation
string

Responses

Request samples

Content type
application/json
{
  • "id": 162,
  • "company_name": "Test Company from Agent 9. mod",
  • "core_kyb_profile_type_client": "COMPANIES_PRIVATE_COMPANY",
  • "registration_number": "0000XXXXXX. mod",
  • "address_country": "IT",
  • "address_city": "address_city. mod",
  • "address_province": "address_province. mod",
  • "address_zip_code": "address_zip_code. mod",
  • "address_street_name": "address_street_name. mod",
  • "address_line": ". mod",
  • "bank_name": "bank_name. mod",
  • "bank_phone": "+34660000001",
  • "account_number": "account_number. mod",
  • "routing_number": ". mod",
  • "swift": ". mod",
  • "iban": ". mod",
  • "bank_address_country": "IT",
  • "bank_address_city": "bank_address_city. mod",
  • "bank_address_province": "bank_address_province. mod",
  • "bank_address_zip_code": "bank_address_zip_code. mod",
  • "bank_address_street_name": "bank_address_street_name. mod",
  • "bank_address_line": ". mod",
  • "first_name": "first_name. mod",
  • "last_name": "last_name. mod",
  • "email": "company10_for_agent@revolupay.es",
  • "phone": "+34660000002",
  • "language": "english",
  • "password": "*************1",
  • "password_repeat": "*************1",
  • "objective_operation": "objective_operation. mod"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success",
  • "result": {
    }
}

Obtiene una compañía por id

Authorizations:
api_key
Request Body schema: application/json
required
id
required
integer

Identificador interno de la compañía

Responses

Request samples

Content type
application/json
{
  • "id": 162
}

Response samples

Content type
application/json
{}

Obtiene una compañía por id indicando idioma

Authorizations:
api_key
path Parameters
language
required
string
Default: "english"
Enum: "english" "spanish"
Request Body schema: application/json
required
id
required
integer

Responses

Request samples

Content type
application/json
{
  • "id": 162
}

Response samples

Content type
application/json
{}

Lista compañías del agente con paginación y filtros

Authorizations:
api_key
Request Body schema: application/json
optional
Array of objects

Lista de filtros simples (clave-valor)

sort
string

Campo de ordenación (por defecto 'id')

dir
string
Enum: "ASC" "DESC"

Dirección de ordenación

page
integer

Número de página (>=1)

page_size
integer

Tamaño de página

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "sort": "id",
  • "dir": "ASC",
  • "page": 1,
  • "page_size": 20
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success",
  • "result": {
    }
}

Lista compañías indicando idioma

Authorizations:
api_key
path Parameters
language
required
string
Default: "english"
Enum: "english" "spanish"
Request Body schema: application/json
optional
Array of objects

Lista de filtros simples (clave-valor)

sort
string

Campo de ordenación (por defecto 'id')

dir
string
Enum: "ASC" "DESC"

Dirección de ordenación

page
integer

Número de página (>=1)

page_size
integer

Tamaño de página

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "sort": "id",
  • "dir": "ASC",
  • "page": 1,
  • "page_size": 20
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success",
  • "result": {
    }
}

Lista transacciones CORE de una compañía

Devuelve las transacciones del CORE (wallets, fees, transfers, TPV, etc.) asociadas a la compañía indicada, con paginación.

Authorizations:
api_key
Request Body schema: application/json
required
id
required
integer

Identificador interno de la compañía (profile_foreign_company)

page
integer

Número de página (>=1)

page_size
integer

Tamaño de página

Responses

Request samples

Content type
application/json
{
  • "id": 121,
  • "page_size": 5,
  • "page": 3
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success",
  • "result": {
    }
}

Lista transacciones CORE de una compañía (idioma)

Authorizations:
api_key
path Parameters
language
required
string
Default: "english"
Enum: "english" "spanish"
Request Body schema: application/json
required
id
required
integer

Identificador interno de la compañía (profile_foreign_company)

page
integer

Número de página (>=1)

page_size
integer

Tamaño de página

Responses

Request samples

Content type
application/json
{
  • "id": 121,
  • "page_size": 5,
  • "page": 3
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success",
  • "result": {
    }
}

Notifica ingreso por transferencia bancaria

Registra un ingreso por transferencia bancaria aportando un comprobante en base64.

Authorizations:
api_key
Request Body schema: application/json
required
profile_id
required
integer

Id del perfil de compañía (profile_foreign_company)

currency
required
string
Enum: "EUR" "USD" "GBP" "CAD"

Código de divisa

amount_cents
required
integer

Importe en céntimos (>0)

file_base64
required
string <byte>

Contenido base64 del comprobante de la transferencia (gif,jpg,png,pdf,docx)

Responses

Request samples

Content type
application/json
{
  • "profile_id": 4,
  • "currency": "USD",
  • "amount_cents": 200050,
  • "file_base64": "data:image/jpeg;base64,/9j/4QNVRXhpZgAATU0AKgAAAAgABwESAAMAAAABAAEAAAEaAAUAAAABAAAAYgEbAAUAAAABAAAAagEoAAMAAAABAAIAAAExAAIAAAAkAAAAcgEyAAIAAAAUAAAAlodpAAQAAAABAAAArAAAANgAHoSAAAAnEAAehIAAACcQQWRvYmUgUGhvdG9zaG9wIENDIDIwMTggKE1hY2ludG9zaCkAMjAyMDowNDozMCAxNjo0NDozNwAAAAADoAEAAwAAAAH//wAAoAIABAAAAAEAAAABoAMABAAAAAEAAAABAAAAAAAAAAYBAwADAAAAAQAGAAABGgAFAAAAAQAAASYBGwAFAAAAAQAAAS4BKAADAAAAAQACAAACAQAEAAAAAQAAATYCAgAEAAAAAQAAAhcAAAAAAAAASAAAAAEAAABIAAAAAf/Y/+0ADEFkb2JlX0NNAAL/7gAOQWRvYmUAZIAAAAAB/9sAhAAMCAgICQgMCQkMEQsKCxEVDwwMDxUYExMVExMYEQwMDAwMDBEMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMAQ0LCw0ODRAODhAUDg4OFBQODg4OFBEMDAwMDBERDAwMDAwMEQwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAz/wAARCAABAAEDASIAAhEBAxEB/90ABAAB/8QBPwAAAQUBAQEBAQEAAAAAAAAAAwABAgQFBgcICQoLAQABBQEBAQEBAQAAAAAAAAABAAIDBAUGBwgJCgsQAAEEAQMCBAIFBwYIBQMMMwEAAhEDBCESMQVBUWETInGBMgYUkaGxQiMkFVLBYjM0coLRQwclklPw4fFjczUWorKDJkSTVGRFwqN0NhfSVeJl8rOEw9N14/NGJ5SkhbSVxNTk9KW1xdXl9VZmdoaWprbG1ub2N0dXZ3eHl6e3x9fn9xEAAgIBAgQEAwQFBgcHBgU1AQACEQMhMRIEQVFhcSITBTKBkRShsUIjwVLR8DMkYuFygpJDUxVjczTxJQYWorKDByY1wtJEk1SjF2RFVTZ0ZeLys4TD03Xj80aUpIW0lcTU5PSltcXV5fVWZnaGlqa2xtbm9ic3R1dnd4eXp7fH/9oADAMBAAIRAxEAPwD1VJfKqSSn/9n/7QtWUGhvdG9zaG9wIDMuMAA4QklNBCUAAAAAABAAAAAAAAAAAAAAAAAAAAAAOEJJTQQ6AAAAAAEXAAAAEAAAAAEAAAAAAAtwcmludE91dHB1dAAAAAUAAAAAUHN0U2Jvb2wBAAAAAEludGVlbnVtAAAAAEludGUAAAAASW1nIAAAAA9wcmludFNpeHRlZW5CaXRib29sAAAAAAtwcmludGVyTmFtZVRFWFQAAAAVAEUAUABTAE8ATgAgAFcARgAtADQANwA0ADAAIABTAGUAcgBpAGUAcwAAAAAAD3ByaW50UHJvb2ZTZXR1cE9iamMAAAARAEEAagB1AHMAdABlACAAZABlACAAcAByAHUAZQBiAGEAAAAAAApwcm9vZlNldHVwAAAAAQAAAABCbHRuZW51bQAAAAxidWlsdGluUHJvb2YAAAAJcHJvb2ZDTVlLADhCSU0EOwAAAAACLQAAABAAAAABAAAAAAAScHJpbnRPdXRwdXRPcHRpb25zAAAAFwAAAABDcHRuYm9vbAAAAAAAQ2xicmJvb2wAAAAAAFJnc01ib29sAAAAAABDcm5DYm9vbAAAAAAAQ250Q2Jvb2wAAAAAAExibHNib29sAAAAAABOZ3R2Ym9vbAAAAAAARW1sRGJvb2wAAAAAAEludHJib29sAAAAAABCY2tnT2JqYwAAAAEAAAAAAABSR0JDAAAAAwAAAABSZCAgZG91YkBv4AAAAAAAAAAAAEdybiBkb3ViQG/gAAAAAAAAAAAAQmwgIGRvdWJAb+AAAAAAAAAAAABCcmRUVW50RiNSbHQAAAAAAAAAAAAAAABCbGQgVW50RiNSbHQAAAAAAAAAAAAAAABSc2x0VW50RiNQeGxAaQAAAAAAAAAAAAp2ZWN0b3JEYXRhYm9vbAEAAAAAUGdQc2VudW0AAAAAUGdQcwAAAABQZ1BDAAAAAExlZnRVbnRGI1JsdAAAAAAAAAAAAAAAAFRvcCBVbnRGI1JsdAAAAAAAAAAAAAAAAFNjbCBVbnRGI1ByY0BZAAAAAAAAAAAAEGNyb3BXaGVuUHJpbnRpbmdib29sAAAAAA5jcm9wUmVjdEJvdHRvbWxvbmcAAAAAAAAADGNyb3BSZWN0TGVmdGxvbmcAAAAAAAAADWNyb3BSZWN0UmlnaHRsb25nAAAAAAAAAAtjcm9wUmVjdFRvcGxvbmcAAAAAADhCSU0D7QAAAAAAEADIAAAAAQACAMgAAAABAAI4QklNBCYAAAAAAA4AAAAAAAAAAAAAP4AAADhCSU0EDQAAAAAABAAAAFo4QklNBBkAAAAAAAQAAAAeOEJJTQPzAAAAAAAJAAAAAAAAAAABADhCSU0nEAAAAAAACgABAAAAAAAAAAI4QklNA/UAAAAAAEgAL2ZmAAEAbGZmAAYAAAAAAAEAL2ZmAAEAoZmaAAYAAAAAAAEAMgAAAAEAWgAAAAYAAAAAAAEANQAAAAEALQAAAAYAAAAAAAE4QklNA/gAAAAAAHAAAP////////////////////////////8D6AAAAAD/////////////////////////////A+gAAAAA/////////////////////////////wPoAAAAAP////////////////////////////8D6AAAOEJJTQQIAAAAAAAQAAAAAQAAAkAAAAJAAAAAADhCSU0EHgAAAAAABAAAAAA4QklNBBoAAAAAA00AAAAGAAAAAAAAAAAAAAABAAAAAQAAAAwAUwBpAG4AIAB0AO0AdAB1AGwAbwAtADQAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAEAAAABAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAAEAAAAAAABudWxsAAAAAgAAAAZib3VuZHNPYmpjAAAAAQAAAAAAAFJjdDEAAAAEAAAAAFRvcCBsb25nAAAAAAAAAABMZWZ0bG9uZwAAAAAAAAAAQnRvbWxvbmcAAAABAAAAAFJnaHRsb25nAAAAAQAAAAZzbGljZXNWbExzAAAAAU9iamMAAAABAAAAAAAFc2xpY2UAAAASAAAAB3NsaWNlSURsb25nAAAAAAAAAAdncm91cElEbG9uZwAAAAAAAAAGb3JpZ2luZW51bQAAAAxFU2xpY2VPcmlnaW4AAAANYXV0b0dlbmVyYXRlZAAAAABUeXBlZW51bQAAAApFU2xpY2VUeXBlAAAAAEltZyAAAAAGYm91bmRzT2JqYwAAAAEAAAAAAABSY3QxAAAABAAAAABUb3AgbG9uZwAAAAAAAAAATGVmdGxvbmcAAAAAAAAAAEJ0b21sb25nAAAAAQAAAABSZ2h0bG9uZwAAAAEAAAADdXJsVEVYVAAAAAEAAAAAAABudWxsVEVYVAAAAAEAAAAAAABNc2dlVEVYVAAAAAEAAAAAAAZhbHRUYWdURVhUAAAAAQAAAAAADmNlbGxUZXh0SXNIVE1MYm9vbAEAAAAIY2VsbFRleHRURVhUAAAAAQAAAAAACWhvcnpBbGlnbmVudW0AAAAPRVNsaWNlSG9yekFsaWduAAAAB2RlZmF1bHQAAAAJdmVydEFsaWduZW51bQAAAA9FU2xpY2VWZXJ0QWxpZ24AAAAHZGVmYXVsdAAAAAtiZ0NvbG9yVHlwZWVudW0AAAARRVNsaWNlQkdDb2xvclR5cGUAAAAATm9uZQAAAAl0b3BPdXRzZXRsb25nAAAAAAAAAApsZWZ0T3V0c2V0bG9uZwAAAAAAAAAMYm90dG9tT3V0c2V0bG9uZwAAAAAAAAALcmlnaHRPdXRzZXRsb25nAAAAAAA4QklNBCgAAAAAAAwAAAACP/AAAAAAAAA4QklNBBEAAAAAAAEBADhCSU0EFAAAAAAABAAAAAE4QklNBAwAAAAAAjMAAAABAAAAAQAAAAEAAAAEAAAABAAAAhcAGAAB/9j/7QAMQWRvYmVfQ00AAv/uAA5BZG9iZQBkgAAAAAH/2wCEAAwICAgJCAwJCQwRCwoLERUPDAwPFRgTExUTExgRDAwMDAwMEQwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwBDQsLDQ4NEA4OEBQODg4UFA4ODg4UEQwMDAwMEREMDAwMDAwRDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDP/AABEIAAEAAQMBIgACEQEDEQH/3QAEAAH/xAE/AAABBQEBAQEBAQAAAAAAAAADAAECBAUGBwgJCgsBAAEFAQEBAQEBAAAAAAAAAAEAAgMEBQYHCAkKCxAAAQQBAwIEAgUHBggFAwwzAQACEQMEIRIxBUFRYRMicYEyBhSRobFCIyQVUsFiMzRygtFDByWSU/Dh8WNzNRaisoMmRJNUZEXCo3Q2F9JV4mXys4TD03Xj80YnlKSFtJXE1OT0pbXF1eX1VmZ2hpamtsbW5vY3R1dnd4eXp7fH1+f3EQACAgECBAQDBAUGBwcGBTUBAAIRAyExEgRBUWFxIhMFMoGRFKGxQiPBUtHwMyRi4XKCkkNTFWNzNPElBhaisoMHJjXC0kSTVKMXZEVVNnRl4vKzhMPTdePzRpSkhbSVxNTk9KW1xdXl9VZmdoaWprbG1ub2JzdHV2d3h5ent8f/2gAMAwEAAhEDEQA/APVUl8qpJKf/2QA4QklNBCEAAAAAAF0AAAABAQAAAA8AQQBkAG8AYgBlACAAUABoAG8AdABvAHMAaABvAHAAAAAXAEEAZABvAGIAZQAgAFAAaABvAHQAbwBzAGgAbwBwACAAQwBDACAAMgAwADEAOAAAAAEAOEJJTQQGAAAAAAAH//wAAAABAQD/4Q0BaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wLwA8P3hwYWNrZXQgYmVnaW49Iu+7vyIgaWQ9Ilc1TTBNcENlaGlIenJlU3pOVGN6a2M5ZCI/PiA8eDp4bXBtZXRhIHhtbG5zOng9ImFkb2JlOm5zOm1ldGEvIiB4OnhtcHRrPSJBZG9iZSBYTVAgQ29yZSA1LjYtYzE0MCA3OS4xNjA0NTEsIDIwMTcvMDUvMDYtMDE6MDg6MjEgICAgICAgICI+IDxyZGY6UkRGIHhtbG5zOnJkZj0iaHR0cDovL3d3dy53My5vcmcvMTk5OS8wMi8yMi1yZGYtc3ludGF4LW5zIyI+IDxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSIiIHhtbG5zOnhtcD0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wLyIgeG1sbnM6ZGM9Imh0dHA6Ly9wdXJsLm9yZy9kYy9lbGVtZW50cy8xLjEvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RFdnQ9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZUV2ZW50IyIgeG1sbnM6cGhvdG9zaG9wPSJodHRwOi8vbnMuYWRvYmUuY29tL3Bob3Rvc2hvcC8xLjAvIiB4bXA6Q3JlYXRvclRvb2w9IkFkb2JlIFBob3Rvc2hvcCBDQyAyMDE4IChNYWNpbnRvc2gpIiB4bXA6Q3JlYXRlRGF0ZT0iMjAyMC0wNC0zMFQxNjo0NDozNyswMjowMCIgeG1wOk1ldGFkYXRhRGF0ZT0iMjAyMC0wNC0zMFQxNjo0NDozNyswMjowMCIgeG1wOk1vZGlmeURhdGU9IjIwMjAtMDQtMzBUMTY6NDQ6MzcrMDI6MDAiIGRjOmZvcm1hdD0iaW1hZ2UvanBlZyIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDo2YWRmOTQwNi03OTA1LTQ5NzEtODc2Mi1iMzcwY2FhZDQzOTkiIHhtcE1NOkRvY3VtZW50SUQ9InhtcC5kaWQ6NmFkZjk0MDYtNzkwNS00OTcxLTg3NjItYjM3MGNhYWQ0Mzk5IiB4bXBNTTpPcmlnaW5hbERvY3VtZW50SUQ9InhtcC5kaWQ6NmFkZjk0MDYtNzkwNS00OTcxLTg3NjItYjM3MGNhYWQ0Mzk5IiBwaG90b3Nob3A6Q29sb3JNb2RlPSIzIj4gPHhtcE1NOkhpc3Rvcnk+IDxyZGY6U2VxPiA8cmRmOmxpIHN0RXZ0OmFjdGlvbj0iY3JlYXRlZCIgc3RFdnQ6aW5zdGFuY2VJRD0ieG1wLmlpZDo2YWRmOTQwNi03OTA1LTQ5NzEtODc2Mi1iMzcwY2FhZDQzOTkiIHN0RXZ0OndoZW49IjIwMjAtMDQtMzBUMTY6NDQ6MzcrMDI6MDAiIHN0RXZ0OnNvZnR3YXJlQWdlbnQ9IkFkb2JlIFBob3Rvc2hvcCBDQyAyMDE4IChNYWNpbnRvc2gpIi8+IDwvcmRmOlNlcT4gPC94bXBNTTpIaXN0b3J5PiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICA8P3hwYWNrZXQgZW5kPSJ3Ij8+/+4ADkFkb2JlAGSAAAAAAf/bAIQAICEhMyQzUTAwUUIvLy9CJxwcHBwnIhcXFxcXIhEMDAwMDAwRDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAEiMzM0JjQiGBgiFA4ODhQUDg4ODhQRDAwMDAwREQwMDAwMDBEMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwM/8AAEQgAAQABAwEiAAIRAQMRAf/dAAQAAf/EARsAAAMBAQEBAQEBAQEAAAAAAAEAAgMEBQYHCAkKCwEBAQEBAQEBAQEBAQEAAAAAAAECAwQFBgcICQoLEAACAgEDAgMEBwYDAwYCATUBAAIRAyESMQRBUSITYXEygZGxQqEF0cEU8FIjcjNi4YLxQzSSorIV0lMkc8JjBoOT4vKjRFRkJTVFFiZ0NlVls4TD03Xj80aUpIW0lcTU5PSltcXV5fVWZnaGlqa2xtbm9hEAAgIABQEGBgEDAQMFAwYvAAERAiEDMUESUWFxgZEiEzLwobEEwdHh8UJSI2JyFJIzgkMkorI0U0Rjc8LSg5OjVOLyBRUlBhYmNWRFVTZ0ZbOEw9N14/NGlKSFtJXE1OT0pbXF1eX1VmZ2hv/aAAwDAQACEQMRAD8A+gV/P1QP/9k="
}

Response samples

Content type
application/json
{}

Notifica ingreso por transferencia bancaria (idioma)

Authorizations:
api_key
path Parameters
language
required
string
Default: "english"
Enum: "english" "spanish"
Request Body schema: application/json
required
profile_id
required
integer

Id del perfil de compañía (profile_foreign_company)

currency
required
string
Enum: "EUR" "USD" "GBP" "CAD"

Código de divisa

amount_cents
required
integer

Importe en céntimos (>0)

file_base64
required
string <byte>

Contenido base64 del comprobante de la transferencia (gif,jpg,png,pdf,docx)

Responses

Request samples

Content type
application/json
{
  • "profile_id": 4,
  • "currency": "USD",
  • "amount_cents": 200050,
  • "file_base64": "data:image/jpeg;base64,/9j/4QNVRXhpZgAATU0AKgAAAAgABwESAAMAAAABAAEAAAEaAAUAAAABAAAAYgEbAAUAAAABAAAAagEoAAMAAAABAAIAAAExAAIAAAAkAAAAcgEyAAIAAAAUAAAAlodpAAQAAAABAAAArAAAANgAHoSAAAAnEAAehIAAACcQQWRvYmUgUGhvdG9zaG9wIENDIDIwMTggKE1hY2ludG9zaCkAMjAyMDowNDozMCAxNjo0NDozNwAAAAADoAEAAwAAAAH//wAAoAIABAAAAAEAAAABoAMABAAAAAEAAAABAAAAAAAAAAYBAwADAAAAAQAGAAABGgAFAAAAAQAAASYBGwAFAAAAAQAAAS4BKAADAAAAAQACAAACAQAEAAAAAQAAATYCAgAEAAAAAQAAAhcAAAAAAAAASAAAAAEAAABIAAAAAf/Y/+0ADEFkb2JlX0NNAAL/7gAOQWRvYmUAZIAAAAAB/9sAhAAMCAgICQgMCQkMEQsKCxEVDwwMDxUYExMVExMYEQwMDAwMDBEMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMAQ0LCw0ODRAODhAUDg4OFBQODg4OFBEMDAwMDBERDAwMDAwMEQwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAz/wAARCAABAAEDASIAAhEBAxEB/90ABAAB/8QBPwAAAQUBAQEBAQEAAAAAAAAAAwABAgQFBgcICQoLAQABBQEBAQEBAQAAAAAAAAABAAIDBAUGBwgJCgsQAAEEAQMCBAIFBwYIBQMMMwEAAhEDBCESMQVBUWETInGBMgYUkaGxQiMkFVLBYjM0coLRQwclklPw4fFjczUWorKDJkSTVGRFwqN0NhfSVeJl8rOEw9N14/NGJ5SkhbSVxNTk9KW1xdXl9VZmdoaWprbG1ub2N0dXZ3eHl6e3x9fn9xEAAgIBAgQEAwQFBgcHBgU1AQACEQMhMRIEQVFhcSITBTKBkRShsUIjwVLR8DMkYuFygpJDUxVjczTxJQYWorKDByY1wtJEk1SjF2RFVTZ0ZeLys4TD03Xj80aUpIW0lcTU5PSltcXV5fVWZnaGlqa2xtbm9ic3R1dnd4eXp7fH/9oADAMBAAIRAxEAPwD1VJfKqSSn/9n/7QtWUGhvdG9zaG9wIDMuMAA4QklNBCUAAAAAABAAAAAAAAAAAAAAAAAAAAAAOEJJTQQ6AAAAAAEXAAAAEAAAAAEAAAAAAAtwcmludE91dHB1dAAAAAUAAAAAUHN0U2Jvb2wBAAAAAEludGVlbnVtAAAAAEludGUAAAAASW1nIAAAAA9wcmludFNpeHRlZW5CaXRib29sAAAAAAtwcmludGVyTmFtZVRFWFQAAAAVAEUAUABTAE8ATgAgAFcARgAtADQANwA0ADAAIABTAGUAcgBpAGUAcwAAAAAAD3ByaW50UHJvb2ZTZXR1cE9iamMAAAARAEEAagB1AHMAdABlACAAZABlACAAcAByAHUAZQBiAGEAAAAAAApwcm9vZlNldHVwAAAAAQAAAABCbHRuZW51bQAAAAxidWlsdGluUHJvb2YAAAAJcHJvb2ZDTVlLADhCSU0EOwAAAAACLQAAABAAAAABAAAAAAAScHJpbnRPdXRwdXRPcHRpb25zAAAAFwAAAABDcHRuYm9vbAAAAAAAQ2xicmJvb2wAAAAAAFJnc01ib29sAAAAAABDcm5DYm9vbAAAAAAAQ250Q2Jvb2wAAAAAAExibHNib29sAAAAAABOZ3R2Ym9vbAAAAAAARW1sRGJvb2wAAAAAAEludHJib29sAAAAAABCY2tnT2JqYwAAAAEAAAAAAABSR0JDAAAAAwAAAABSZCAgZG91YkBv4AAAAAAAAAAAAEdybiBkb3ViQG/gAAAAAAAAAAAAQmwgIGRvdWJAb+AAAAAAAAAAAABCcmRUVW50RiNSbHQAAAAAAAAAAAAAAABCbGQgVW50RiNSbHQAAAAAAAAAAAAAAABSc2x0VW50RiNQeGxAaQAAAAAAAAAAAAp2ZWN0b3JEYXRhYm9vbAEAAAAAUGdQc2VudW0AAAAAUGdQcwAAAABQZ1BDAAAAAExlZnRVbnRGI1JsdAAAAAAAAAAAAAAAAFRvcCBVbnRGI1JsdAAAAAAAAAAAAAAAAFNjbCBVbnRGI1ByY0BZAAAAAAAAAAAAEGNyb3BXaGVuUHJpbnRpbmdib29sAAAAAA5jcm9wUmVjdEJvdHRvbWxvbmcAAAAAAAAADGNyb3BSZWN0TGVmdGxvbmcAAAAAAAAADWNyb3BSZWN0UmlnaHRsb25nAAAAAAAAAAtjcm9wUmVjdFRvcGxvbmcAAAAAADhCSU0D7QAAAAAAEADIAAAAAQACAMgAAAABAAI4QklNBCYAAAAAAA4AAAAAAAAAAAAAP4AAADhCSU0EDQAAAAAABAAAAFo4QklNBBkAAAAAAAQAAAAeOEJJTQPzAAAAAAAJAAAAAAAAAAABADhCSU0nEAAAAAAACgABAAAAAAAAAAI4QklNA/UAAAAAAEgAL2ZmAAEAbGZmAAYAAAAAAAEAL2ZmAAEAoZmaAAYAAAAAAAEAMgAAAAEAWgAAAAYAAAAAAAEANQAAAAEALQAAAAYAAAAAAAE4QklNA/gAAAAAAHAAAP////////////////////////////8D6AAAAAD/////////////////////////////A+gAAAAA/////////////////////////////wPoAAAAAP////////////////////////////8D6AAAOEJJTQQIAAAAAAAQAAAAAQAAAkAAAAJAAAAAADhCSU0EHgAAAAAABAAAAAA4QklNBBoAAAAAA00AAAAGAAAAAAAAAAAAAAABAAAAAQAAAAwAUwBpAG4AIAB0AO0AdAB1AGwAbwAtADQAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAEAAAABAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAAEAAAAAAABudWxsAAAAAgAAAAZib3VuZHNPYmpjAAAAAQAAAAAAAFJjdDEAAAAEAAAAAFRvcCBsb25nAAAAAAAAAABMZWZ0bG9uZwAAAAAAAAAAQnRvbWxvbmcAAAABAAAAAFJnaHRsb25nAAAAAQAAAAZzbGljZXNWbExzAAAAAU9iamMAAAABAAAAAAAFc2xpY2UAAAASAAAAB3NsaWNlSURsb25nAAAAAAAAAAdncm91cElEbG9uZwAAAAAAAAAGb3JpZ2luZW51bQAAAAxFU2xpY2VPcmlnaW4AAAANYXV0b0dlbmVyYXRlZAAAAABUeXBlZW51bQAAAApFU2xpY2VUeXBlAAAAAEltZyAAAAAGYm91bmRzT2JqYwAAAAEAAAAAAABSY3QxAAAABAAAAABUb3AgbG9uZwAAAAAAAAAATGVmdGxvbmcAAAAAAAAAAEJ0b21sb25nAAAAAQAAAABSZ2h0bG9uZwAAAAEAAAADdXJsVEVYVAAAAAEAAAAAAABudWxsVEVYVAAAAAEAAAAAAABNc2dlVEVYVAAAAAEAAAAAAAZhbHRUYWdURVhUAAAAAQAAAAAADmNlbGxUZXh0SXNIVE1MYm9vbAEAAAAIY2VsbFRleHRURVhUAAAAAQAAAAAACWhvcnpBbGlnbmVudW0AAAAPRVNsaWNlSG9yekFsaWduAAAAB2RlZmF1bHQAAAAJdmVydEFsaWduZW51bQAAAA9FU2xpY2VWZXJ0QWxpZ24AAAAHZGVmYXVsdAAAAAtiZ0NvbG9yVHlwZWVudW0AAAARRVNsaWNlQkdDb2xvclR5cGUAAAAATm9uZQAAAAl0b3BPdXRzZXRsb25nAAAAAAAAAApsZWZ0T3V0c2V0bG9uZwAAAAAAAAAMYm90dG9tT3V0c2V0bG9uZwAAAAAAAAALcmlnaHRPdXRzZXRsb25nAAAAAAA4QklNBCgAAAAAAAwAAAACP/AAAAAAAAA4QklNBBEAAAAAAAEBADhCSU0EFAAAAAAABAAAAAE4QklNBAwAAAAAAjMAAAABAAAAAQAAAAEAAAAEAAAABAAAAhcAGAAB/9j/7QAMQWRvYmVfQ00AAv/uAA5BZG9iZQBkgAAAAAH/2wCEAAwICAgJCAwJCQwRCwoLERUPDAwPFRgTExUTExgRDAwMDAwMEQwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwBDQsLDQ4NEA4OEBQODg4UFA4ODg4UEQwMDAwMEREMDAwMDAwRDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDP/AABEIAAEAAQMBIgACEQEDEQH/3QAEAAH/xAE/AAABBQEBAQEBAQAAAAAAAAADAAECBAUGBwgJCgsBAAEFAQEBAQEBAAAAAAAAAAEAAgMEBQYHCAkKCxAAAQQBAwIEAgUHBggFAwwzAQACEQMEIRIxBUFRYRMicYEyBhSRobFCIyQVUsFiMzRygtFDByWSU/Dh8WNzNRaisoMmRJNUZEXCo3Q2F9JV4mXys4TD03Xj80aUpIW0lcTU5PSltcXV5fVWZnaGlqa2xtbm9vY3R1dnd4eXp7fH1+f3EQACAgECBAQDBAUGBwcGBTUBAAIRAyExEgRBUWFxIhMFMoGRFKGxQiPBUtHwMyRi4XKCkkNTFWNzNPElBhaisoMHJjXC0kSTVKMXZEVVNnRl4vKzhMPTdePzRpSkhbSVxNTk9KW1xdXl9VZmdoaWprbG1ub2JzdHV2d3h5ent8f/2gAMAwEAAhEDEQA/APVUl8qpJKf/2QA4QklNBCEAAAAAAF0AAAABAQAAAA8AQQBkAG8AYgBlACAAUABoAG8AdABvAHMAaABvAHAAAAAXAEEAZABvAGIAZQAgAFAAaABvAHQAbwBzAGgAbwBwACAAQwBDACAAMgAwADEAOAAAAAEAOEJJTQQGAAAAAAAH//wAAAABAQD/4Q0BaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wLwA8P3hwYWNrZXQgYmVnaW49Iu+7vyIgaWQ9Ilc1TTBNcENlaGlIenJlU3pOVGN6a2M5ZCI/PiA8eDp4bXBtZXRhIHhtbG5zOng9ImFkb2JlOm5zOm1ldGEvIiB4OnhtcHRrPSJBZG9iZSBYTVAgQ29yZSA1LjYtYzE0MCA3OS4xNjA0NTEsIDIwMTcvMDUvMDYtMDE6MDg6MjEgICAgICAgICI+IDxyZGY6UkRGIHhtbG5zOnJkZj0iaHR0cDovL3d3dy53My5vcmcvMTk5OS8wMi8yMi1yZGYtc3ludGF4LW5zIyI+IDxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSIiIHhtbG5zOnhtcD0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wLyIgeG1sbnM6ZGM9Imh0dHA6Ly9wdXJsLm9yZy9kYy9lbGVtZW50cy8xLjEvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RFdnQ9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZUV2ZW50IyIgeG1sbnM6cGhvdG9zaG9wPSJodHRwOi8vbnMuYWRvYmUuY29tL3Bob3Rvc2hvcC8xLjAvIiB4bXA6Q3JlYXRvclRvb2w9IkFkb2JlIFBob3Rvc2hvcCBDQyAyMDE4IChNYWNpbnRvc2gpIiB4bXA6Q3JlYXRlRGF0ZT0iMjAyMC0wNC0zMFQxNjo0NDozNyswMjowMCIgeG1wOk1ldGFkYXRhRGF0ZT0iMjAyMC0wNC0zMFQxNjo0NDozNyswMjowMCIgeG1wOk1vZGlmeURhdGU9IjIwMjAtMDQtMzBUMTY6NDQ6MzcrMDI6MDAiIGRjOmZvcm1hdD0iaW1hZ2UvanBlZyIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDo2YWRmOTQwNi03OTA1LTQ5NzEtODc2Mi1iMzcwY2FhZDQzOTkiIHhtcE1NOkRvY3VtZW50SUQ9InhtcC5kaWQ6NmFkZjk0MDYtNzkwNS00OTcxLTg3NjItYjM3MGNhYWQ0Mzk5IiB4bXBNTTpPcmlnaW5hbERvY3VtZW50SUQ9InhtcC5kaWQ6NmFkZjk0MDYtNzkwNS00OTcxLTg3NjItYjM3MGNhYWQ0Mzk5IiBwaG90b3Nob3A6Q29sb3JNb2RlPSIzIj4gPHhtcE1NOkhpc3Rvcnk+IDxyZGY6U2VxPiA8cmRmOmxpIHN0RXZ0OmFjdGlvbj0iY3JlYXRlZCIgc3RFdnQ6aW5zdGFuY2VJRD0ieG1wLmlpZDo2YWRmOTQwNi03OTA1LTQ5NzEtODc2Mi1iMzcwY2FhZDQzOTkiIHN0RXZ0OndoZW49IjIwMjAtMDQtMzBUMTY6NDQ6MzcrMDI6MDAiIHN0RXZ0OnNvZnR3YXJlQWdlbnQ9IkFkb2JlIFBob3Rvc2hvcCBDQyAyMDE4IChNYWNpbnRvc2gpIi8+IDwvcmRmOlNlcT4gPC94bXBNTTpIaXN0b3J5PiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICA="
}

Response samples

Content type
application/json
{}

Obtiene ingreso por transferencia bancaria por internal_code

Recupera un ingreso previamente notificado por su código interno.

Authorizations:
api_key
Request Body schema: application/json
required
profile_id
required
integer

Id del perfil de compañía (profile_foreign_company)

internal_code
required
string

Código interno del ingreso

Responses

Request samples

Content type
application/json
{
  • "profile_id": 4,
  • "internal_code": "IO2511202279"
}

Response samples

Content type
application/json
{}

Obtiene ingreso por transferencia bancaria (idioma)

Authorizations:
api_key
path Parameters
language
required
string
Default: "english"
Enum: "english" "spanish"
Request Body schema: application/json
required
profile_id
required
integer

Id del perfil de compañía (profile_foreign_company)

internal_code
required
string

Código interno del ingreso

Responses

Request samples

Content type
application/json
{
  • "profile_id": 4,
  • "internal_code": "IO2511202279"
}

Response samples

Content type
application/json
{}

Lista ingresos por transferencia bancaria de una compañía

Devuelve los ingresos notificados vía transferencia bancaria asociados al perfil indicado, con paginación y filtros de fecha.

Authorizations:
api_key
Request Body schema: application/json
required
profile_id
required
integer

Id del perfil de compañía (profile_foreign_company)

Array of objects

Filtros de rango por fecha. Claves soportadas:

  • date (string date-time): inicio de rango, compara created_at >= date.
  • dateTo (string date-time): fin de rango, compara created_at <= dateTo.
sort
string

Campo de ordenación (por defecto 'id')

dir
string
Enum: "ASC" "DESC"

Dirección de ordenación

page
integer

Número de página (>=1)

page_size
integer

Tamaño de página

Responses

Request samples

Content type
application/json
{
  • "profile_id": 4,
  • "filters": [
    ],
  • "sort": "id",
  • "dir": "DESC",
  • "page": 2,
  • "page_size": 10
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success",
  • "result": {
    }
}

Lista ingresos por transferencia bancaria de una compañía (idioma)

Authorizations:
api_key
path Parameters
language
required
string
Default: "english"
Enum: "english" "spanish"
Request Body schema: application/json
required
profile_id
required
integer

Id del perfil de compañía (profile_foreign_company)

Array of objects

Filtros de rango por fecha. Claves soportadas:

  • date (string date-time): inicio de rango, compara created_at >= date.
  • dateTo (string date-time): fin de rango, compara created_at <= dateTo.
sort
string

Campo de ordenación (por defecto 'id')

dir
string
Enum: "ASC" "DESC"

Dirección de ordenación

page
integer

Número de página (>=1)

page_size
integer

Tamaño de página

Responses

Request samples

Content type
application/json
{
  • "profile_id": 4,
  • "filters": [
    ],
  • "sort": "id",
  • "dir": "DESC",
  • "page": 2,
  • "page_size": 10
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success",
  • "result": {
    }
}

files

Subida y asociación de ficheros KYB/KYC a la compañía

Sube y asocia un fichero KYB/KYC a la compañía

Authorizations:
api_key
Request Body schema: application/json
required
id
required
integer

Id de la compañía

file_name
required
string
Enum: "deed_of_incorporation_of_the_company" "registration_certificate_of_the_company" "photocopy_of_the_company_tax_dentification_card" "certificate_of_nomination_of_directors_and_or_attorneys" "photocopy_of_directors_and_attorneys_id_who_will_act_on_behalf_of_the_company" "declaration_form_of_the_real_owner_of_the_company" "corporation_tax_forms" "bank_account_certificate" "audited_annual_accounts"

Tipo de documento a asociar

file_base64
required
string <byte>

Contenido del archivo en base64. Se aceptan (gif,jpg,png,pdf,docx)

Responses

Request samples

Content type
application/json
{
  • "id": 4,
  • "file_name": "audited_annual_accounts",
  • "file_base64": "data:image/jpeg;base64,/9j/4QNVRXhpZgAATU0AKgAAAAgABwESAAMAAAABAAEAAAEaAAUAAAABAAAAYgEbAAUAAAABAAAAagEoAAMAAAABAAIAAAExAAIAAAAkAAAAcgEyAAIAAAAUAAAAlodpAAQAAAABAAAArAAAANgAHoSAAAAnEAAehIAAACcQQWRvYmUgUGhvdG9zaG9wIENDIDIwMTggKE1hY2ludG9zaCkAMjAyMDowNDozMCAxNjo0NDozNwAAAAADoAEAAwAAAAH//wAAoAIABAAAAAEAAAABoAMABAAAAAEAAAABAAAAAAAAAAYBAwADAAAAAQAGAAABGgAFAAAAAQAAASYBGwAFAAAAAQAAAS4BKAADAAAAAQACAAACAQAEAAAAAQAAATYCAgAEAAAAAQAAAhcAAAAAAAAASAAAAAEAAABIAAAAAf/Y/+0ADEFkb2JlX0NNAAL/7gAOQWRvYmUAZIAAAAAB/9sAhAAMCAgICQgMCQkMEQsKCxEVDwwMDxUYExMVExMYEQwMDAwMDBEMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMAQ0LCw0ODRAODhAUDg4OFBQODg4OFBEMDAwMDBERDAwMDAwMEQwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAz/wAARCAABAAEDASIAAhEBAxEB/8QAFQABAQAAAAAAAAAAAAAAAAAAAAb/xAAUEAEAAAAAAAAAAAAAAAAAAAAA/8QAFQEBAQAAAAAAAAAAAAAAAAAAAwT/xAAUEQEAAAAAAAAAAAAAAAAAAAAA/9oADAMBAAIRAxEAPwCDgAAB//Z"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success",
  • "result": {
    }
}

Sube y asocia un fichero KYB/KYC a la compañía indicando idioma

Authorizations:
api_key
path Parameters
language
required
string
Default: "english"
Enum: "english" "spanish"
Request Body schema: application/json
required
id
required
integer

Id de la compañía

file_name
required
string
Enum: "deed_of_incorporation_of_the_company" "registration_certificate_of_the_company" "photocopy_of_the_company_tax_dentification_card" "certificate_of_nomination_of_directors_and_or_attorneys" "photocopy_of_directors_and_attorneys_id_who_will_act_on_behalf_of_the_company" "declaration_form_of_the_real_owner_of_the_company" "corporation_tax_forms" "bank_account_certificate" "audited_annual_accounts"

Tipo de documento a asociar

file_base64
required
string <byte>

Contenido del archivo en base64. Se aceptan (gif,jpg,png,pdf,docx)

Responses

Request samples

Content type
application/json
{
  • "id": 4,
  • "file_name": "audited_annual_accounts",
  • "file_base64": "data:image/jpeg;base64,/9j/4QNVRXhpZgAATU0AKgAAAAgABwESAAMAAAABAAEAAAEaAAUAAAABAAAAYgEbAAUAAAABAAAAagEoAAMAAAABAAIAAAExAAIAAAAkAAAAcgEyAAIAAAAUAAAAlodpAAQAAAABAAAArAAAANgAHoSAAAAnEAAehIAAACcQQWRvYmUgUGhvdG9zaG9wIENDIDIwMTggKE1hY2ludG9zaCkAMjAyMDowNDozMCAxNjo0NDozNwAAAAADoAEAAwAAAAH//wAAoAIABAAAAAEAAAABoAMABAAAAAEAAAABAAAAAAAAAAYBAwADAAAAAQAGAAABGgAFAAAAAQAAASYBGwAFAAAAAQAAAS4BKAADAAAAAQACAAACAQAEAAAAAQAAATYCAgAEAAAAAQAAAhcAAAAAAAAASAAAAAEAAABIAAAAAf/Y/+0ADEFkb2JlX0NNAAL/7gAOQWRvYmUAZIAAAAAB/9sAhAAMCAgICQgMCQkMEQsKCxEVDwwMDxUYExMVExMYEQwMDAwMDBEMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMAQ0LCw0ODRAODhAUDg4OFBQODg4OFBEMDAwMDBERDAwMDAwMEQwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAz/wAARCAABAAEDASIAAhEBAxEB/8QAFQABAQAAAAAAAAAAAAAAAAAAAAb/xAAUEAEAAAAAAAAAAAAAAAAAAAAA/8QAFQEBAQAAAAAAAAAAAAAAAAAAAwT/xAAUEQEAAAAAAAAAAAAAAAAAAAAA/9oADAMBAAIRAxEAPwCDgAAB//Z"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success",
  • "result": {
    }
}

login_init

Flujo de login iniciado por el agente para usuarios de la compañía (OTP)

Inicia el flujo de login OTP para una compañía

Crea una sesión de login iniciada por el agente para que un usuario de la compañía se autentique (usuario/contraseña + OTP). Tras el OTP, el agente recibirá notificación JSON con un token de sesión de compañía.

Authorizations:
api_key
Request Body schema: application/json
required
profile_id
required
integer

Id de la compañía (profile_foreign_company)

notify_url
required
string <uri>

URL del agente para notificación JSON con el token de sesión

ok_redirect_url
string <uri>

URL a la que se redirige al usuario tras éxito

ko_redirect_url
string <uri>

URL a la que se redirige al usuario tras fallo

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success",
  • "result": {}
}

Inicia el flujo de login OTP para una compañía (idioma)

Authorizations:
api_key
path Parameters
language
required
string
Default: "english"
Enum: "english" "spanish"
Request Body schema: application/json
required
profile_id
required
integer

Id de la compañía (profile_foreign_company)

notify_url
required
string <uri>

URL del agente para notificación JSON con el token de sesión

ok_redirect_url
string <uri>

URL a la que se redirige al usuario tras éxito

ko_redirect_url
string <uri>

URL a la que se redirige al usuario tras fallo

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success",
  • "result": {}
}

tpv

Creación de órdenes TPV usando tokens de sesión de compañía

Crea una orden TPV usando un token de sesión de compañía

Requiere token de sesión emitido tras completar el login OTP de compañía.

Authorizations:
api_key
Request Body schema: application/json
required
session_token
required
string

Token emitido tras completar el login OTP de la compañía

amount_cents
required
integer

Importe en céntimos (>0)

currency
required
string
Enum: "EUR" "USD"
url_ok
string <uri>
url_ko
string <uri>
url_post
string <uri>
description
string
order_ext_id
string
customer_ext_id
string
source_uuid
string
clientFirstName
string
clientLastName
string
clientEmail
string <email>
clientPhonePrefix
string
clientPhoneNumber
string
clientAddressCity
string
clientAddressCountryISO3
string
clientAddress
string
clientAddressZip
string
clientAddressState
string

Responses

Request samples

Content type
application/json
{
  • "session_token": "string",
  • "amount_cents": 1020,
  • "currency": "EUR",
  • "url_ok": "http://example.com",
  • "url_ko": "http://example.com",
  • "url_post": "http://example.com",
  • "description": "Rocker T-shirt x 1",
  • "order_ext_id": "RTH-000001",
  • "customer_ext_id": "CL1-000-CV-98",
  • "source_uuid": "77777777-7777-4777-9777-777777777777",
  • "clientFirstName": "Alan",
  • "clientLastName": "Brito",
  • "clientEmail": "alan@example.com",
  • "clientPhonePrefix": "34",
  • "clientPhoneNumber": "938930586",
  • "clientAddressCity": "Barcelona",
  • "clientAddressCountryISO3": "ESP",
  • "clientAddress": "C/ Mayor 1",
  • "clientAddressZip": "08001",
  • "clientAddressState": "Barcelona"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success",
  • "result": {
    }
}

Crea una orden TPV usando un token de sesión de compañía (idioma)

Authorizations:
api_key
path Parameters
language
required
string
Default: "english"
Enum: "english" "spanish"
Request Body schema: application/json
required
session_token
required
string

Token emitido tras completar el login OTP de la compañía

amount_cents
required
integer

Importe en céntimos (>0)

currency
required
string
Enum: "EUR" "USD"
url_ok
string <uri>
url_ko
string <uri>
url_post
string <uri>
description
string
order_ext_id
string
customer_ext_id
string
source_uuid
string
clientFirstName
string
clientLastName
string
clientEmail
string <email>
clientPhonePrefix
string
clientPhoneNumber
string
clientAddressCity
string
clientAddressCountryISO3
string
clientAddress
string
clientAddressZip
string
clientAddressState
string

Responses

Request samples

Content type
application/json
{
  • "session_token": "string",
  • "amount_cents": 1020,
  • "currency": "EUR",
  • "url_ok": "http://example.com",
  • "url_ko": "http://example.com",
  • "url_post": "http://example.com",
  • "description": "Rocker T-shirt x 1",
  • "order_ext_id": "RTH-000001",
  • "customer_ext_id": "CL1-000-CV-98",
  • "source_uuid": "77777777-7777-4777-9777-777777777777",
  • "clientFirstName": "Alan",
  • "clientLastName": "Brito",
  • "clientEmail": "alan@example.com",
  • "clientPhonePrefix": "34",
  • "clientPhoneNumber": "938930586",
  • "clientAddressCity": "Barcelona",
  • "clientAddressCountryISO3": "ESP",
  • "clientAddress": "C/ Mayor 1",
  • "clientAddressZip": "08001",
  • "clientAddressState": "Barcelona"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success",
  • "result": {
    }
}

Solicita un reembolso de una orden TPV usando el token de sesión de compañía

Requiere el token de sesión emitido tras completar el login OTP de compañía y el internal_code de la orden TPV.

Authorizations:
api_key
Request Body schema: application/json
required
session_token
required
string

Token emitido tras completar el login OTP de la compañía

amount_cents
required
integer

Importe a reembolsar en céntimos (>0)

internal_code
required
string

Código interno de la orden TPV a reembolsar

Responses

Request samples

Content type
application/json
{
  • "session_token": "e2cf457b24733ed99839c6890b581626f858eca8da1c2f88",
  • "amount_cents": 1,
  • "internal_code": "TPV211214594"
}

Response samples

Content type
application/json
{}

Solicita un reembolso de una orden TPV (idioma)

Authorizations:
api_key
path Parameters
language
required
string
Default: "english"
Enum: "english" "spanish"
Request Body schema: application/json
required
session_token
required
string

Token emitido tras completar el login OTP de la compañía

amount_cents
required
integer

Importe a reembolsar en céntimos (>0)

internal_code
required
string

Código interno de la orden TPV a reembolsar

Responses

Request samples

Content type
application/json
{
  • "session_token": "e2cf457b24733ed99839c6890b581626f858eca8da1c2f88",
  • "amount_cents": 1,
  • "internal_code": "TPV211214594"
}

Response samples

Content type
application/json
{}

Lista órdenes TPV de una compañía por perfil

Devuelve las transacciones TPV del perfil de compañía indicado, validando que pertenezca al agente.

Authorizations:
api_key
Request Body schema: application/json
required
profile_id
required
integer

Id del perfil de compañía (profile_foreign_company)

Array of objects

Filtros aplicados al listado. Estructura: array de objetos con UNA sola clave cada uno. Claves permitidas y su semántica:

  • internal_code (string): igualdad exacta sobre el código interno.
  • service_status (string): estado de la orden (LIKE en base de datos). Valores habituales: pending, accepted, refused, 'paid out'.
  • currency_code (string): divisa (LIKE), p.ej. EUR, USD.
  • date (string date-time): inicio de rango, compara created_at >= date.
  • dateTo (string date-time): fin de rango, compara created_at <= dateTo.
  • code (string): código público de la orden (LIKE).
  • id (string|integer): id interno de la orden (LIKE). Nota: profile_id/profile_type y environment se establecen internamente; no es necesario enviarlos como filtros.
sort
string

Campo de ordenación (por defecto "id"). Soportados: id, created_at, service_status, currency_code.

dir
string
Enum: "ASC" "DESC"

Dirección de ordenación

page
integer

Número de página (>=1)

page_size
integer

Tamaño de página

Responses

Request samples

Content type
application/json
Example
{
  • "profile_id": 162,
  • "page": 1,
  • "page_size": 100
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success",
  • "result": {
    }
}

Lista órdenes TPV (idioma)

Authorizations:
api_key
path Parameters
language
required
string
Default: "english"
Enum: "english" "spanish"
Request Body schema: application/json
required
profile_id
required
integer

Id del perfil de compañía (profile_foreign_company)

Array of objects

Filtros aplicados al listado. Estructura: array de objetos con UNA sola clave cada uno. Claves permitidas y su semántica:

  • internal_code (string): igualdad exacta sobre el código interno.
  • service_status (string): estado de la orden (LIKE en base de datos). Valores habituales: pending, accepted, refused, 'paid out'.
  • currency_code (string): divisa (LIKE), p.ej. EUR, USD.
  • date (string date-time): inicio de rango, compara created_at >= date.
  • dateTo (string date-time): fin de rango, compara created_at <= dateTo.
  • code (string): código público de la orden (LIKE).
  • id (string|integer): id interno de la orden (LIKE). Nota: profile_id/profile_type y environment se establecen internamente; no es necesario enviarlos como filtros.
sort
string

Campo de ordenación (por defecto "id"). Soportados: id, created_at, service_status, currency_code.

dir
string
Enum: "ASC" "DESC"

Dirección de ordenación

page
integer

Número de página (>=1)

page_size
integer

Tamaño de página

Responses

Request samples

Content type
application/json
Example
{
  • "profile_id": 162,
  • "page": 1,
  • "page_size": 100
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success",
  • "result": {
    }
}

Obtiene una orden TPV concreta por internal_code

Authorizations:
api_key
Request Body schema: application/json
required
profile_id
required
integer

Id del perfil de compañía (profile_foreign_company)

internal_code
required
string

Código interno de la orden TPV

Responses

Request samples

Content type
application/json
{
  • "profile_id": 162,
  • "internal_code": "TPV211214594"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success",
  • "result": {
    }
}

Obtiene una orden TPV concreta (idioma)

Authorizations:
api_key
path Parameters
language
required
string
Default: "english"
Enum: "english" "spanish"
Request Body schema: application/json
required
profile_id
required
integer

Id del perfil de compañía (profile_foreign_company)

internal_code
required
string

Código interno de la orden TPV

Responses

Request samples

Content type
application/json
{
  • "profile_id": 162,
  • "internal_code": "TPV211214594"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success",
  • "result": {
    }
}

Lista liquidaciones TPV del agente

Devuelve las operaciones de liquidación (paid out) de TPV gestionadas por el agente, con paginación y filtros opcionales.

Authorizations:
api_key
Request Body schema: application/json
optional
Array of objects

Filtros opcionales. Claves sugeridas: status, currency, company_name, period_date_end (rango con date/dateTo), paid_date (rango), notified (true/false). Formato de filtros: array de objetos con una sola clave cada uno, igual que en listados de TPV.

sort
string

Campo de ordenación (por defecto created_at). Soportados: created_at, paid_date, period_date_end, company_name, currency.

dir
string
Enum: "ASC" "DESC"
page
integer
page_size
integer

Responses

Request samples

Content type
application/json
{
  • "page": 1,
  • "page_size": 100
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success",
  • "result": {
    }
}

Lista liquidaciones TPV del agente (idioma)

Authorizations:
api_key
path Parameters
language
required
string
Default: "english"
Enum: "english" "spanish"
Request Body schema: application/json
optional
Array of objects

Filtros opcionales. Claves sugeridas: status, currency, company_name, period_date_end (rango con date/dateTo), paid_date (rango), notified (true/false). Formato de filtros: array de objetos con una sola clave cada uno, igual que en listados de TPV.

sort
string

Campo de ordenación (por defecto created_at). Soportados: created_at, paid_date, period_date_end, company_name, currency.

dir
string
Enum: "ASC" "DESC"
page
integer
page_size
integer

Responses

Request samples

Content type
application/json
{
  • "page": 1,
  • "page_size": 100
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success",
  • "result": {
    }
}

Obtiene el detalle de una liquidación TPV por código

Authorizations:
api_key
Request Body schema: application/json
required
code
required
string

Código público de la liquidación TPV (p.ej. TPV.D3CrZ.596)

Responses

Request samples

Content type
application/json
{
  • "code": "TPV.D3CrZ.596"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success",
  • "result": {
    }
}

Obtiene el detalle de una liquidación TPV por código (idioma)

Authorizations:
api_key
path Parameters
language
required
string
Default: "english"
Enum: "english" "spanish"
Request Body schema: application/json
required
code
required
string

Código público de la liquidación TPV (p.ej. TPV.D3CrZ.596)

Responses

Request samples

Content type
application/json
{
  • "code": "TPV.D3CrZ.596"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success",
  • "result": {
    }
}

settlement

Liquidaciones TPV (cierres y pagos)

Lista liquidaciones TPV del agente

Devuelve las operaciones de liquidación (paid out) de TPV gestionadas por el agente, con paginación y filtros opcionales.

Authorizations:
api_key
Request Body schema: application/json
optional
Array of objects

Filtros opcionales. Claves sugeridas: status, currency, company_name, period_date_end (rango con date/dateTo), paid_date (rango), notified (true/false). Formato de filtros: array de objetos con una sola clave cada uno, igual que en listados de TPV.

sort
string

Campo de ordenación (por defecto created_at). Soportados: created_at, paid_date, period_date_end, company_name, currency.

dir
string
Enum: "ASC" "DESC"
page
integer
page_size
integer

Responses

Request samples

Content type
application/json
{
  • "page": 1,
  • "page_size": 100
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success",
  • "result": {
    }
}

Lista liquidaciones TPV del agente (idioma)

Authorizations:
api_key
path Parameters
language
required
string
Default: "english"
Enum: "english" "spanish"
Request Body schema: application/json
optional
Array of objects

Filtros opcionales. Claves sugeridas: status, currency, company_name, period_date_end (rango con date/dateTo), paid_date (rango), notified (true/false). Formato de filtros: array de objetos con una sola clave cada uno, igual que en listados de TPV.

sort
string

Campo de ordenación (por defecto created_at). Soportados: created_at, paid_date, period_date_end, company_name, currency.

dir
string
Enum: "ASC" "DESC"
page
integer
page_size
integer

Responses

Request samples

Content type
application/json
{
  • "page": 1,
  • "page_size": 100
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success",
  • "result": {
    }
}

Obtiene el detalle de una liquidación TPV por código

Authorizations:
api_key
Request Body schema: application/json
required
code
required
string

Código público de la liquidación TPV (p.ej. TPV.D3CrZ.596)

Responses

Request samples

Content type
application/json
{
  • "code": "TPV.D3CrZ.596"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success",
  • "result": {
    }
}

Obtiene el detalle de una liquidación TPV por código (idioma)

Authorizations:
api_key
path Parameters
language
required
string
Default: "english"
Enum: "english" "spanish"
Request Body schema: application/json
required
code
required
string

Código público de la liquidación TPV (p.ej. TPV.D3CrZ.596)

Responses

Request samples

Content type
application/json
{
  • "code": "TPV.D3CrZ.596"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success",
  • "result": {
    }
}

rates

Obtiene tipos de cambio para una divisa

Devuelve el tipo de cambio de compra y venta para la divisa indicada.

Authorizations:
api_key
query Parameters
currency
string
Example: currency=CAD

Código ISO-4217 de la divisa (p.ej. CAD) por defecto USD

header Parameters
x-api-key
required
string

API Key del agente

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success",
  • "result": [
    ]
}

Historial de tipos de cambio (idioma por defecto english)

Devuelve cotizaciones históricas de la divisa desde una fecha dada (formato Y-m-d). Paginado. Idioma por defecto 'english'.

Authorizations:
api_key
header Parameters
x-api-key
required
string

API Key del agente

Request Body schema: application/json
required
currency
string

Código ISO-4217 (por defecto USD si se omite)

from
required
string <date>

Fecha inicio (Y-m-d)

page_size
integer
page
integer

Responses

Request samples

Content type
application/json
{
  • "currency": "CAD",
  • "from": "2025-10-28",
  • "page_size": 10,
  • "page": 2
}

Response samples

Content type
application/json
{
  • "currency": "CAD",
  • "from": "2025-10-28",
  • "result": [
    ],
  • "pagination": {
    }
}

Obtiene tipos de cambio indicando idioma

Igual que /agent/rate, permitiendo fijar idioma ('english'|'spanish').

Authorizations:
api_key
path Parameters
language
required
string
Default: "english"
Enum: "english" "spanish"
query Parameters
currency
string
Example: currency=CAD

Código ISO-4217 de la divisa (p.ej. CAD) por defecto USD

header Parameters
x-api-key
required
string

API Key del agente

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success",
  • "result": [
    ]
}

Historial de tipos de cambio

Devuelve cotizaciones históricas de la divisa desde una fecha dada (formato Y-m-d). Paginado.

Authorizations:
api_key
path Parameters
language
required
string
Default: "english"
Enum: "english" "spanish"
Request Body schema: application/json
required
currency
string

Código ISO-4217 (por defecto USD si se omite)

from
required
string <date>

Fecha inicio (Y-m-d)

page_size
integer
page
integer

Responses

Request samples

Content type
application/json
{
  • "currency": "CAD",
  • "from": "2025-10-28",
  • "page_size": 10,
  • "page": 2
}

Response samples

Content type
application/json
{
  • "currency": "CAD",
  • "from": "2025-10-28",
  • "result": [
    ],
  • "pagination": {
    }
}