LunaPay® · Documentation

From your first payment to your own integration.

Download OpenAPI 3.1

Reviewed on 2026-09-19

Resource reference

Versioned OpenAPI 3.1 contract from Payments. Only resources on the public /v1 route are included.

Run examples on your server with your own sandbox data. Never include keys in the frontend. This documentation does not enable live operations.

Reading the contract

Each operation shows method, path, parameters, body and responses. Generic response schemas remain generic; no fields are invented. Approved contract, account and issuer UUIDs are obtained through the dashboard and its approval process.

Customers customers

GET/v1/customers

Parameters

Server example
[
  {
    "name": "limit",
    "in": "query",
    "schema": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 50
    }
  },
  {
    "name": "before",
    "in": "query",
    "description": "ID de la última fila de la página anterior; orden creado/id descendente.",
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
]

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}
POST/v1/customers

Parameters

Server example
[
  {
    "name": "Idempotency-Key",
    "in": "header",
    "required": true,
    "schema": {
      "type": "string",
      "minLength": 8,
      "maxLength": 200
    }
  }
]

JSON request body

Server example
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    },
    "email": {
      "type": "string",
      "maxLength": 254,
      "format": "email",
      "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
    },
    "country": {
      "type": "string",
      "minLength": 2,
      "maxLength": 2
    },
    "taxId": {
      "type": "string",
      "maxLength": 30
    },
    "taxCondition": {
      "type": "string",
      "maxLength": 100
    }
  },
  "required": [
    "name",
    "email",
    "country"
  ],
  "additionalProperties": false
}

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}
GET/v1/customers/{id}

Parameters

Server example
[
  {
    "name": "id",
    "in": "path",
    "required": true,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
]

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}
POST/v1/customers/{id}/update

Parameters

Server example
[
  {
    "name": "id",
    "in": "path",
    "required": true,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  },
  {
    "name": "Idempotency-Key",
    "in": "header",
    "required": true,
    "schema": {
      "type": "string",
      "minLength": 8,
      "maxLength": 200
    }
  }
]

JSON request body

Server example
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "version": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "patch": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 500
        },
        "email": {
          "type": "string",
          "maxLength": 254,
          "format": "email",
          "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
        },
        "country": {
          "type": "string",
          "minLength": 2,
          "maxLength": 2
        },
        "taxId": {
          "type": "string",
          "maxLength": 30
        },
        "taxCondition": {
          "type": "string",
          "maxLength": 100
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "version",
    "patch"
  ],
  "additionalProperties": false
}

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}

Products products

GET/v1/products

Parameters

Server example
[
  {
    "name": "limit",
    "in": "query",
    "schema": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 50
    }
  },
  {
    "name": "before",
    "in": "query",
    "description": "ID de la última fila de la página anterior; orden creado/id descendente.",
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
]

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}
POST/v1/products

Parameters

Server example
[
  {
    "name": "Idempotency-Key",
    "in": "header",
    "required": true,
    "schema": {
      "type": "string",
      "minLength": 8,
      "maxLength": 200
    }
  }
]

JSON request body

Server example
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    },
    "description": {
      "type": "string",
      "maxLength": 4000
    },
    "activity": {
      "type": "string",
      "enum": [
        "technology_product",
        "technology_service"
      ]
    },
    "sellerEntityId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "evidence": {
      "type": "string",
      "maxLength": 1000
    },
    "active": {
      "default": true,
      "type": "boolean"
    },
    "imageId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "required": [
    "name",
    "description",
    "activity",
    "sellerEntityId",
    "active"
  ],
  "additionalProperties": false
}

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}
GET/v1/products/{id}

Parameters

Server example
[
  {
    "name": "id",
    "in": "path",
    "required": true,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
]

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}
POST/v1/products/{id}/update

Parameters

Server example
[
  {
    "name": "id",
    "in": "path",
    "required": true,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  },
  {
    "name": "Idempotency-Key",
    "in": "header",
    "required": true,
    "schema": {
      "type": "string",
      "minLength": 8,
      "maxLength": 200
    }
  }
]

JSON request body

Server example
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "version": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "patch": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 500
        },
        "description": {
          "type": "string",
          "maxLength": 4000
        },
        "activity": {
          "type": "string",
          "enum": [
            "technology_product",
            "technology_service"
          ]
        },
        "sellerEntityId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "evidence": {
          "type": "string",
          "maxLength": 1000
        },
        "active": {
          "default": true,
          "type": "boolean"
        },
        "imageId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "version",
    "patch"
  ],
  "additionalProperties": false
}

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}

Prices prices

GET/v1/prices

Parameters

Server example
[
  {
    "name": "limit",
    "in": "query",
    "schema": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 50
    }
  },
  {
    "name": "before",
    "in": "query",
    "description": "ID de la última fila de la página anterior; orden creado/id descendente.",
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
]

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}
POST/v1/prices

Parameters

Server example
[
  {
    "name": "Idempotency-Key",
    "in": "header",
    "required": true,
    "schema": {
      "type": "string",
      "minLength": 8,
      "maxLength": 200
    }
  }
]

JSON request body

Server example
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "productId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "currency": {
      "type": "string",
      "enum": [
        "ARS",
        "USD",
        "EUR",
        "USDT",
        "USDC",
        "BTC"
      ]
    },
    "amountMinor": {
      "type": "string",
      "pattern": "^[1-9]\\d{0,17}$"
    },
    "taxIncluded": {
      "type": "boolean"
    },
    "saleTaxPolicyId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "recurring": {
      "type": "object",
      "properties": {
        "interval": {
          "type": "string",
          "enum": [
            "month",
            "year",
            "week",
            "day"
          ]
        },
        "count": {
          "type": "integer",
          "minimum": 1,
          "maximum": 12
        },
        "trial": {
          "type": "boolean"
        }
      },
      "required": [
        "interval",
        "count",
        "trial"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "productId",
    "currency",
    "amountMinor",
    "taxIncluded"
  ],
  "additionalProperties": false
}

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}
GET/v1/prices/{id}

Parameters

Server example
[
  {
    "name": "id",
    "in": "path",
    "required": true,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
]

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}

Checkout sessions checkout-sessions

GET/v1/checkout-sessions

Parameters

Server example
[
  {
    "name": "limit",
    "in": "query",
    "schema": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 50
    }
  },
  {
    "name": "before",
    "in": "query",
    "description": "ID de la última fila de la página anterior; orden creado/id descendente.",
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
]

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}
POST/v1/checkout-sessions

Parameters

Server example
[
  {
    "name": "Idempotency-Key",
    "in": "header",
    "required": true,
    "schema": {
      "type": "string",
      "minLength": 8,
      "maxLength": 200
    }
  }
]

JSON request body

Server example
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "reference": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "contractId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "customerId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "currency": {
      "type": "string",
      "enum": [
        "ARS",
        "USD",
        "EUR",
        "USDT",
        "USDC",
        "BTC"
      ]
    },
    "allowedAccountIds": {
      "minItems": 1,
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid",
        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
      }
    },
    "items": {
      "minItems": 1,
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "priceId": {
            "type": "string",
            "format": "uuid",
            "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
          },
          "quantity": {
            "type": "integer",
            "minimum": 1,
            "maximum": 1000
          }
        },
        "required": [
          "priceId",
          "quantity"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "reference",
    "contractId",
    "customerId",
    "currency",
    "items"
  ],
  "additionalProperties": false
}

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}
GET/v1/checkout-sessions/{id}

Parameters

Server example
[
  {
    "name": "id",
    "in": "path",
    "required": true,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
]

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}

Payments payments

GET/v1/payments

Parameters

Server example
[
  {
    "name": "limit",
    "in": "query",
    "schema": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 50
    }
  },
  {
    "name": "before",
    "in": "query",
    "description": "ID de la última fila de la página anterior; orden creado/id descendente.",
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
]

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}
GET/v1/payments/{id}

Parameters

Server example
[
  {
    "name": "id",
    "in": "path",
    "required": true,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
]

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}
POST/v1/payments/{id}/start

Parameters

Server example
[
  {
    "name": "id",
    "in": "path",
    "required": true,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  },
  {
    "name": "Idempotency-Key",
    "in": "header",
    "required": true,
    "schema": {
      "type": "string",
      "minLength": 8,
      "maxLength": 200
    }
  }
]

JSON request body

Server example
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "accountId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "selection": {
      "type": "object",
      "properties": {
        "campaignId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "brand": {
          "type": "string"
        }
      },
      "required": [
        "campaignId",
        "brand"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "accountId"
  ],
  "additionalProperties": false
}

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}

Refunds refunds

GET/v1/refunds

Parameters

Server example
[
  {
    "name": "limit",
    "in": "query",
    "schema": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 50
    }
  },
  {
    "name": "before",
    "in": "query",
    "description": "ID de la última fila de la página anterior; orden creado/id descendente.",
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
]

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}
POST/v1/refunds

Parameters

Server example
[
  {
    "name": "Idempotency-Key",
    "in": "header",
    "required": true,
    "schema": {
      "type": "string",
      "minLength": 8,
      "maxLength": 200
    }
  }
]

JSON request body

Server example
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "orderId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "amountMinor": {
      "type": "string",
      "pattern": "^[1-9]\\d*$"
    },
    "reason": {
      "type": "string",
      "minLength": 3
    },
    "feePolicy": {
      "type": "string",
      "enum": [
        "proportional",
        "retain_service_fee"
      ]
    },
    "policyEvidence": {
      "type": "string"
    }
  },
  "required": [
    "orderId",
    "amountMinor",
    "reason",
    "feePolicy",
    "policyEvidence"
  ],
  "additionalProperties": false
}

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}
GET/v1/refunds/{id}

Parameters

Server example
[
  {
    "name": "id",
    "in": "path",
    "required": true,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
]

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}

Subscriptions subscriptions

GET/v1/subscriptions

Parameters

Server example
[
  {
    "name": "limit",
    "in": "query",
    "schema": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 50
    }
  },
  {
    "name": "before",
    "in": "query",
    "description": "ID de la última fila de la página anterior; orden creado/id descendente.",
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
]

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}
POST/v1/subscriptions

Parameters

Server example
[
  {
    "name": "Idempotency-Key",
    "in": "header",
    "required": true,
    "schema": {
      "type": "string",
      "minLength": 8,
      "maxLength": 200
    }
  }
]

JSON request body

Server example
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "customerId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "priceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "contractId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "accountId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "mode": {
      "type": "string",
      "enum": [
        "automatic_recurring",
        "manual_renewal"
      ]
    },
    "termsVersion": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "consent": {
      "type": "boolean",
      "const": true
    },
    "allowedAccountIds": {
      "minItems": 1,
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid",
        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
      }
    }
  },
  "required": [
    "customerId",
    "priceId",
    "contractId",
    "mode",
    "termsVersion",
    "consent"
  ],
  "additionalProperties": false
}

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}
GET/v1/subscriptions/{id}

Parameters

Server example
[
  {
    "name": "id",
    "in": "path",
    "required": true,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
]

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}
POST/v1/subscriptions/{id}/cancel

Parameters

Server example
[
  {
    "name": "id",
    "in": "path",
    "required": true,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  },
  {
    "name": "Idempotency-Key",
    "in": "header",
    "required": true,
    "schema": {
      "type": "string",
      "minLength": 8,
      "maxLength": 200
    }
  }
]

JSON request body

Server example
{
  "type": "object",
  "additionalProperties": false
}

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}
POST/v1/subscriptions/{id}/portal

Parameters

Server example
[
  {
    "name": "id",
    "in": "path",
    "required": true,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  },
  {
    "name": "Idempotency-Key",
    "in": "header",
    "required": true,
    "schema": {
      "type": "string",
      "minLength": 8,
      "maxLength": 200
    }
  }
]

JSON request body

Server example
{
  "type": "object",
  "additionalProperties": false
}

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}

Balances balances

GET/v1/balances

Parameters

Server example
[
  {
    "name": "limit",
    "in": "query",
    "schema": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 50
    }
  },
  {
    "name": "before",
    "in": "query",
    "description": "ID de la última fila de la página anterior; orden creado/id descendente.",
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
]

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}

Transactions transactions

GET/v1/transactions

Parameters

Server example
[
  {
    "name": "limit",
    "in": "query",
    "schema": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 50
    }
  },
  {
    "name": "before",
    "in": "query",
    "description": "ID de la última fila de la página anterior; orden creado/id descendente.",
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
]

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}
GET/v1/transactions/{id}

Parameters

Server example
[
  {
    "name": "id",
    "in": "path",
    "required": true,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
]

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}

Invoices invoices

GET/v1/invoices

Parameters

Server example
[
  {
    "name": "limit",
    "in": "query",
    "schema": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 50
    }
  },
  {
    "name": "before",
    "in": "query",
    "description": "ID de la última fila de la página anterior; orden creado/id descendente.",
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
]

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}
GET/v1/invoices/{id}

Parameters

Server example
[
  {
    "name": "id",
    "in": "path",
    "required": true,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
]

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}
POST/v1/invoices/{id}/download

Parameters

Server example
[
  {
    "name": "id",
    "in": "path",
    "required": true,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  },
  {
    "name": "Idempotency-Key",
    "in": "header",
    "required": true,
    "schema": {
      "type": "string",
      "minLength": 8,
      "maxLength": 200
    }
  }
]

JSON request body

Server example
{
  "type": "object",
  "additionalProperties": false
}

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}

Settlements settlements

GET/v1/settlements

Parameters

Server example
[
  {
    "name": "limit",
    "in": "query",
    "schema": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 50
    }
  },
  {
    "name": "before",
    "in": "query",
    "description": "ID de la última fila de la página anterior; orden creado/id descendente.",
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
]

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}
GET/v1/settlements/{id}

Parameters

Server example
[
  {
    "name": "id",
    "in": "path",
    "required": true,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
]

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}

Payout requests payout-requests

GET/v1/payout-requests

Parameters

Server example
[
  {
    "name": "limit",
    "in": "query",
    "schema": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 50
    }
  },
  {
    "name": "before",
    "in": "query",
    "description": "ID de la última fila de la página anterior; orden creado/id descendente.",
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
]

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}
POST/v1/payout-requests

Parameters

Server example
[
  {
    "name": "Idempotency-Key",
    "in": "header",
    "required": true,
    "schema": {
      "type": "string",
      "minLength": 8,
      "maxLength": 200
    }
  }
]

JSON request body

Server example
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "entityId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "currency": {
      "type": "string",
      "enum": [
        "ARS",
        "USD",
        "EUR",
        "USDT",
        "USDC",
        "BTC"
      ]
    },
    "amountMinor": {
      "type": "string",
      "pattern": "^[1-9]\\d{0,17}$"
    },
    "channel": {
      "type": "string",
      "enum": [
        "cbu_cvu",
        "ach",
        "wire",
        "crypto"
      ]
    },
    "beneficiaryId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "contractId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "required": [
    "entityId",
    "currency",
    "amountMinor",
    "channel",
    "beneficiaryId",
    "contractId"
  ],
  "additionalProperties": false
}

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}
GET/v1/payout-requests/{id}

Parameters

Server example
[
  {
    "name": "id",
    "in": "path",
    "required": true,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
]

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}
POST/v1/payout-requests/{id}/cancel

Parameters

Server example
[
  {
    "name": "id",
    "in": "path",
    "required": true,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  },
  {
    "name": "Idempotency-Key",
    "in": "header",
    "required": true,
    "schema": {
      "type": "string",
      "minLength": 8,
      "maxLength": 200
    }
  }
]

JSON request body

Server example
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "reason": {
      "type": "string",
      "minLength": 3
    }
  },
  "required": [
    "reason"
  ],
  "additionalProperties": false
}

Response and errors

Server example
{
  "200": {
    "description": "Resultado. Importes en unidades menores como strings.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {}
          }
        }
      }
    }
  },
  "400": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "401": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "403": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "404": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "409": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "429": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  },
  "500": {
    "description": "Error consistente con código y requestId. No contiene secretos.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}

Development contract · source: Payments · 9f82d06