{ "openapi": "3.1.0", "info": { "title": "Thub API", "description": "\n## Welcome to PayLead Thub API Documentation!\n \n- Release Version: **None**\n- API Version: **1.1.2**\n\nThis documentation is designed to help you go through the phases of\nbasic implementation, and help you understand the basic steps to follow to\nreach your objectives via our API.\n\n## Getting Started\n\nOur API is a RESTful API.\n\nA RESTful API explicitly takes advantage of HTTP methodologies defined by\nthe RFC 2616 protocol. We use:\n\n- `GET` to retrieve a resource\n\n- `PUT` to change the state of or update a resource, which can be an\nobject, file or block\n\n- `POST` to create that resource\n\n- `DELETE` to remove it\n\n\nYou can use the API to access all endpoints, such as the Transactions\nendpoint to post transactions, or the banks endpoint to get the list of\navailable banks.\n\n\nThe API is organized around REST. JSON is returned by all API responses,\nincluding errors. In all API requests, you must set `the content-type` HTTP\nheader to application/JSON. All API requests must be made over HTTPS. Calls\nmade over HTTP will fail.\n\nTo access and work with our API, make sure you have been provided the\nfollowing elements by our Ops team:\n\n- A developers Shift account \n- Defined a bank mapping\n\n\n## Versioning\n\nOur API supports versioning, so be sure to set the right version in the\nheader, using the `X-Api-Version`\n\n\nex: `X-Api-Version = 1.0.0`\n\n## Base URL\n\nAll API URLs referenced in this documentation start with the following base URL: `https://api.sandbox.paylead.fr/`\n\n## Response Code\n\nOur API returns standard HTTP response codes to indicate success or failure\nof the API requests. For errors, we also return a customized error message\ninside the JSON response. You can see the returned HTTP status codes below.\n|Code | Title | Description |\n|-----|-----------------------|----------------------------------------------------------------------------------------------------|\n| 200 | OK | Request successful |\n| 201 | Created | Resource successfully created |\n| 204 | No Content | Request successful with no content returned |\n| 400 | Bad Request | Request was unacceptable |\n| 401 | Unauthorized | Missing API Key or invalid |\n| 403 | Forbidden | Access is forbidden |\n| 404 | Not Found | Resource does not exist |\n| 405 | Method not allowed | he method is not allowed for the requested URL. |\n| 409 | Conflict | The request could not be completed due to a conflict with the current state of the target resource |\n| 500 | Internal server error | Something went wrong with the PayLead API |\n| 503 | Internal server error | Some service are unavailable |\n\n", "version": "1.1.2" }, "paths": { "/health-check": { "get": { "tags": [ "Health" ], "summary": "Health Check", "operationId": "health_check_health_check_get", "responses": { "200": { "description": "Successful Health Check", "content": { "application/json": { "schema": {}, "example": { "status": "healthy" } } } } } } }, "/consumers/health-check": { "get": { "tags": [ "Health" ], "summary": "Consumer Health Check", "operationId": "consumer_health_check_consumers_health_check_get", "responses": { "200": { "description": "Successful Health Check", "content": { "application/json": { "schema": {}, "example": { "status": "healthy" } } } } } } }, "/banks": { "get": { "tags": [ "Bank" ], "summary": "Get the list of bank", "description": "Returns the list of all banks available on the program linked to the consumer.", "operationId": "get--banks", "security": [ { "Authentication Token": [] } ], "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 50, "title": "Per Page" } }, { "name": "name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" } }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_PayleadPage_BankOutSchema_" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "message": "Bad Request" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "message": "Missing or invalid Authorization Header." } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "message": "You don’t have permission to access this resource." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "message": "Internal Server Error" } } } } } } }, "/consumers/{consumer_id}/banks": { "get": { "tags": [ "Bank Connection" ], "summary": "Get the list of bank connection", "description": "Returns the list of bank connection for consumer `consumer_id`.", "operationId": "get--consumers-consumer_id-banks", "security": [ { "Authentication Token": [] } ], "parameters": [ { "name": "consumer_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 2, "maxLength": 100, "description": "Unique ID of the consumer that you have registered when the user was onboarded.", "title": "Consumer Id" }, "description": "Unique ID of the consumer that you have registered when the user was onboarded." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 50, "title": "Per Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_PayleadPage_BankConnectionOutSchema_" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "message": "Bad Request" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "message": "Missing or invalid Authorization Header." } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "message": "You don’t have permission to access this resource." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "message": "Resource Not Found" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "message": "Conflict error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "message": "Internal Server Error" } } } } } }, "post": { "tags": [ "Bank Connection" ], "summary": "Create bank connection", "description": "Creates a new bank connection for consumer `consumer_id`.", "operationId": "post--consumers-consumer_id-banks", "security": [ { "Authentication Token": [] } ], "parameters": [ { "name": "consumer_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 2, "maxLength": 100, "description": "Unique ID of the consumer that you have registered when the user was onboarded.", "title": "Consumer Id" }, "description": "Unique ID of the consumer that you have registered when the user was onboarded." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankConnectionCreateSchema" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankConnectionOutSchema" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "message": "Bad Request" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "message": "Missing or invalid Authorization Header." } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "message": "You don’t have permission to access this resource." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "message": "Resource Not Found" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "message": "Conflict error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "message": "Internal Server Error" } } } } } } }, "/consumers/{consumer_id}/banks/{bank_external_id}": { "get": { "tags": [ "Bank Connection" ], "summary": "Get the bank connection details", "description": "Returns all the information about bank connection `bank_external_id` for consumer `consumer_id`.", "operationId": "get--consumers-consumer_id-banks-bank_external_id", "security": [ { "Authentication Token": [] } ], "parameters": [ { "name": "bank_external_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Unique ID of the bank connection that you have registered when the bank connection was created.", "title": "Bank External Id" }, "description": "Unique ID of the bank connection that you have registered when the bank connection was created." }, { "name": "consumer_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 2, "maxLength": 100, "description": "Unique ID of the consumer that you have registered when the user was onboarded.", "title": "Consumer Id" }, "description": "Unique ID of the consumer that you have registered when the user was onboarded." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankConnectionOutSchema" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "message": "Bad Request" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "message": "Missing or invalid Authorization Header." } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "message": "You don’t have permission to access this resource." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "message": "Resource Not Found" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "message": "Conflict error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "message": "Internal Server Error" } } } } } }, "delete": { "tags": [ "Bank Connection" ], "summary": "Delete a bank connection", "description": "Deletes all information about bank connection `bank_external_id` for consumer `consumer_id`.", "operationId": "delete--consumers-consumer_id-banks-bank_external_id", "security": [ { "Authentication Token": [] } ], "parameters": [ { "name": "bank_external_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Unique ID of the bank connection that you have registered when the bank connection was created.", "title": "Bank External Id" }, "description": "Unique ID of the bank connection that you have registered when the bank connection was created." }, { "name": "consumer_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 2, "maxLength": 100, "description": "Unique ID of the consumer that you have registered when the user was onboarded.", "title": "Consumer Id" }, "description": "Unique ID of the consumer that you have registered when the user was onboarded." } ], "responses": { "204": { "description": "Successful Response" }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "message": "Bad Request" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "message": "Missing or invalid Authorization Header." } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "message": "You don’t have permission to access this resource." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "message": "Resource Not Found" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "message": "Conflict error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "message": "Internal Server Error" } } } } } } }, "/consumers/{consumer_id}/banks/{bank_connection_id}/accounts": { "get": { "tags": [ "Bank Account" ], "summary": "Get the list of bank accounts", "description": "Returns the list of bank accounts linked to bank connection `bank_connection_id` for consumer `consumer_id`.", "operationId": "get--consumers-consumer_id-banks-bank_connection_id-accounts", "security": [ { "Authentication Token": [] } ], "parameters": [ { "name": "bank_connection_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "description": "Bank connection uuid", "title": "Bank Connection Id" }, "description": "Bank connection uuid" }, { "name": "consumer_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 2, "maxLength": 100, "description": "Unique ID of the consumer that you have registered when the user was onboarded.", "title": "Consumer Id" }, "description": "Unique ID of the consumer that you have registered when the user was onboarded." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 50, "title": "Per Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_PayleadPage_BankAccountOutSchema_" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "message": "Bad Request" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "message": "Missing or invalid Authorization Header." } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "message": "You don’t have permission to access this resource." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "message": "Resource Not Found" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "message": "Conflict error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "message": "Internal Server Error" } } } } } }, "post": { "tags": [ "Bank Account" ], "summary": "Create a new bank account", "description": "Creates a new bank account linked to bank connection `bank_connection_id` for consumer `consumer_id`.", "operationId": "post--consumers-consumer_id-banks-bank_connection_id-accounts", "security": [ { "Authentication Token": [] } ], "parameters": [ { "name": "bank_connection_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "description": "Bank connection uuid", "title": "Bank Connection Id" }, "description": "Bank connection uuid" }, { "name": "consumer_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 2, "maxLength": 100, "description": "Unique ID of the consumer that you have registered when the user was onboarded.", "title": "Consumer Id" }, "description": "Unique ID of the consumer that you have registered when the user was onboarded." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCreateSchema" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountOutSchema" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "message": "Bad Request" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "message": "Missing or invalid Authorization Header." } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "message": "You don’t have permission to access this resource." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "message": "Resource Not Found" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "message": "Conflict error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "message": "Internal Server Error" } } } } } } }, "/consumers/{consumer_id}/banks/{bank_mapper}/accounts/{account_external_id}": { "get": { "tags": [ "Bank Account" ], "summary": "Get the bank account details", "description": "Returns all the information about account `account_external_id` linked to bank connection `bank_mapper` for consumer `consumer_id`.", "operationId": "get--consumers-consumer_id-banks-bank_mapper-accounts-account_external_id", "security": [ { "Authentication Token": [] } ], "parameters": [ { "name": "bank_mapper", "in": "path", "required": true, "schema": { "type": "string", "description": "Unique identifier of the bank.", "title": "Bank Mapper" }, "description": "Unique identifier of the bank." }, { "name": "account_external_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Unique ID of the bank account that you have registered when the bank account was created.", "title": "Account External Id" }, "description": "Unique ID of the bank account that you have registered when the bank account was created." }, { "name": "consumer_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 2, "maxLength": 100, "description": "Unique ID of the consumer that you have registered when the user was onboarded.", "title": "Consumer Id" }, "description": "Unique ID of the consumer that you have registered when the user was onboarded." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountOutSchema" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "message": "Bad Request" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "message": "Missing or invalid Authorization Header." } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "message": "You don’t have permission to access this resource." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "message": "Resource Not Found" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "message": "Conflict error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "message": "Internal Server Error" } } } } } }, "put": { "tags": [ "Bank Account" ], "summary": "Update bank account", "description": "Update bank account `account_external_id` linked to bank connection `bank_mapper` for consumer `consumer_id`.", "operationId": "put--consumers-consumer_id-banks-bank_mapper-accounts-account_external_id", "security": [ { "Authentication Token": [] } ], "parameters": [ { "name": "bank_mapper", "in": "path", "required": true, "schema": { "type": "string", "description": "Unique identifier of the bank.", "title": "Bank Mapper" }, "description": "Unique identifier of the bank." }, { "name": "account_external_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Unique ID of the bank account that you have registered when the bank account was created.", "title": "Account External Id" }, "description": "Unique ID of the bank account that you have registered when the bank account was created." }, { "name": "consumer_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 2, "maxLength": 100, "description": "Unique ID of the consumer that you have registered when the user was onboarded.", "title": "Consumer Id" }, "description": "Unique ID of the consumer that you have registered when the user was onboarded." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountUpdateSchema" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountOutSchema" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "message": "Bad Request" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "message": "Missing or invalid Authorization Header." } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "message": "You don’t have permission to access this resource." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "message": "Resource Not Found" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "message": "Conflict error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "message": "Internal Server Error" } } } } } }, "delete": { "tags": [ "Bank Account" ], "summary": "Delete bank account", "description": "Delete the bank account `account_id` linked to this `bank_connection_id` bank connection for consumer `consumer_id`.", "operationId": "delete--consumers-consumer_id-banks-bank_mapper-accounts-account_external_id", "security": [ { "Authentication Token": [] } ], "parameters": [ { "name": "bank_mapper", "in": "path", "required": true, "schema": { "type": "string", "description": "Unique identifier of the bank.", "title": "Bank Mapper" }, "description": "Unique identifier of the bank." }, { "name": "account_external_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Unique ID of the bank account that you have registered when the bank account was created.", "title": "Account External Id" }, "description": "Unique ID of the bank account that you have registered when the bank account was created." }, { "name": "consumer_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 2, "maxLength": 100, "description": "Unique ID of the consumer that you have registered when the user was onboarded.", "title": "Consumer Id" }, "description": "Unique ID of the consumer that you have registered when the user was onboarded." } ], "responses": { "204": { "description": "Successful Response" }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "message": "Bad Request" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "message": "Missing or invalid Authorization Header." } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "message": "You don’t have permission to access this resource." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "message": "Resource Not Found" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "message": "Conflict error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "message": "Internal Server Error" } } } } } } }, "/consumers/{consumer_id}/transactions": { "post": { "tags": [ "Bulk Transaction" ], "summary": "Create a bulk of transactions", "description": "Inserts multiple transactions to consumer `consumer_id` using a bulk.", "operationId": "post--consumers-consumer_id-transactions", "security": [ { "Authentication Token": [] } ], "parameters": [ { "name": "consumer_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 2, "maxLength": 100, "description": "Unique ID of the consumer that you have registered when the user was onboarded.", "title": "Consumer Id" }, "description": "Unique ID of the consumer that you have registered when the user was onboarded." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BucketCreateSchema" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptySchema" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "message": "Bad Request" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "message": "Missing or invalid Authorization Header." } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "message": "You don’t have permission to access this resource." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "message": "Resource Not Found" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "message": "Conflict error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "message": "Internal Server Error" } } } } } } }, "/consumers/{consumer_id}/transactions/{transaction_id}": { "get": { "tags": [ "Transaction" ], "summary": "Get the transaction details", "description": "Returns all the information about transaction `transaction_id` on account `account_id` linked to bank connection `bank_connection_id` for consumer `consumer_id`.", "operationId": "get--consumers-consumer_id-transactions-transaction_id", "security": [ { "Authentication Token": [] } ], "parameters": [ { "name": "transaction_id", "in": "path", "required": true, "schema": { "type": "string", "description": "UUID of the transaction or Unique ID of the transaction that you have registered when the transaction was created.", "title": "Transaction Id" }, "description": "UUID of the transaction or Unique ID of the transaction that you have registered when the transaction was created." }, { "name": "consumer_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 2, "maxLength": 100, "description": "Unique ID of the consumer that you have registered when the user was onboarded.", "title": "Consumer Id" }, "description": "Unique ID of the consumer that you have registered when the user was onboarded." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionOutSchema" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "message": "Bad Request" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "message": "Missing or invalid Authorization Header." } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "message": "You don’t have permission to access this resource." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "message": "Resource Not Found" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "message": "Conflict error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "message": "Internal Server Error" } } } } } }, "put": { "tags": [ "Transaction" ], "summary": "Update transaction", "description": "Update the `transaction_id` transaction on `account_id` linked to `bank_connection_id` bank connection for consumer `consumer_id`.", "operationId": "put--consumers-consumer_id-transactions-transaction_id", "security": [ { "Authentication Token": [] } ], "parameters": [ { "name": "transaction_id", "in": "path", "required": true, "schema": { "type": "string", "description": "UUID of the transaction or Unique ID of the transaction that you have registered when the transaction was created.", "title": "Transaction Id" }, "description": "UUID of the transaction or Unique ID of the transaction that you have registered when the transaction was created." }, { "name": "consumer_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 2, "maxLength": 100, "description": "Unique ID of the consumer that you have registered when the user was onboarded.", "title": "Consumer Id" }, "description": "Unique ID of the consumer that you have registered when the user was onboarded." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionUpdateSchema" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionOutSchema" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "message": "Bad Request" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "message": "Missing or invalid Authorization Header." } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "message": "You don’t have permission to access this resource." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "message": "Resource Not Found" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "message": "Conflict error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "message": "Internal Server Error" } } } } } }, "delete": { "tags": [ "Transaction" ], "summary": "Delete transaction", "description": "Delete the transaction `transaction_id` on account `account_id` linked to bank connection `bank_connection_id` for consumer `consumer_id`.", "operationId": "delete--consumers-consumer_id-transactions-transaction_id", "security": [ { "Authentication Token": [] } ], "parameters": [ { "name": "transaction_id", "in": "path", "required": true, "schema": { "type": "string", "description": "UUID of the transaction or Unique ID of the transaction that you have registered when the transaction was created.", "title": "Transaction Id" }, "description": "UUID of the transaction or Unique ID of the transaction that you have registered when the transaction was created." }, { "name": "consumer_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 2, "maxLength": 100, "description": "Unique ID of the consumer that you have registered when the user was onboarded.", "title": "Consumer Id" }, "description": "Unique ID of the consumer that you have registered when the user was onboarded." } ], "responses": { "204": { "description": "Successful Response" }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "message": "Bad Request" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "message": "Missing or invalid Authorization Header." } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "message": "You don’t have permission to access this resource." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "message": "Resource Not Found" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "message": "Conflict error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "message": "Internal Server Error" } } } } } } }, "/consumers/{consumer_id}/banks/{bank_connection_id}/accounts/{bank_account_id}/transactions": { "get": { "tags": [ "Atomic Transaction" ], "summary": "Get the list of transactions", "description": "Returns the list of transactions from account `account_id` linked to bank connection `bank_connection_id` for consumer `consumer_id`.", "operationId": "get--consumers-consumer_id-banks-bank_connection_id-accounts-bank_account_id-transactions", "security": [ { "Authentication Token": [] } ], "parameters": [ { "name": "bank_account_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "description": "Bank account uuid", "title": "Bank Account Id" }, "description": "Bank account uuid" }, { "name": "bank_connection_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "description": "Bank connection uuid", "title": "Bank Connection Id" }, "description": "Bank connection uuid" }, { "name": "consumer_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 2, "maxLength": 100, "description": "Unique ID of the consumer that you have registered when the user was onboarded.", "title": "Consumer Id" }, "description": "Unique ID of the consumer that you have registered when the user was onboarded." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 50, "title": "Per Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_PayleadPage_TransactionOutSchema_" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "message": "Bad Request" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "message": "Missing or invalid Authorization Header." } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "message": "You don’t have permission to access this resource." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "message": "Resource Not Found" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "message": "Conflict error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "message": "Internal Server Error" } } } } } }, "post": { "tags": [ "Atomic Transaction" ], "summary": "Create a transaction", "description": "Creates a transaction on account `account_id` linked to bank connection `bank_connection_id` for consumer `consumer_id`.", "operationId": "post--consumers-consumer_id-banks-bank_connection_id-accounts-bank_account_id-transactions", "security": [ { "Authentication Token": [] } ], "parameters": [ { "name": "bank_account_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "description": "Bank account uuid", "title": "Bank Account Id" }, "description": "Bank account uuid" }, { "name": "bank_connection_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "description": "Bank connection uuid", "title": "Bank Connection Id" }, "description": "Bank connection uuid" }, { "name": "consumer_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 2, "maxLength": 100, "description": "Unique ID of the consumer that you have registered when the user was onboarded.", "title": "Consumer Id" }, "description": "Unique ID of the consumer that you have registered when the user was onboarded." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionCreateSchema" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionOutSchema" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "message": "Bad Request" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "message": "Missing or invalid Authorization Header." } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "message": "You don’t have permission to access this resource." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "message": "Resource Not Found" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "message": "Conflict error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "message": "Internal Server Error" } } } } } } }, "/consumers/{consumer_id}/banks/{bank_connection_id}/accounts/{bank_account_id}/transactions/{transaction_id}": { "get": { "tags": [ "Atomic Transaction" ], "summary": "Get the transaction details", "description": "Returns all the information about transaction `transaction_id` on account `account_id` linked to bank connection `bank_connection_id` for consumer `consumer_id`.", "operationId": "get--consumers-consumer_id-banks-bank_connection_id-accounts-bank_account_id-transactions-transaction_id", "security": [ { "Authentication Token": [] } ], "parameters": [ { "name": "bank_account_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "description": "Bank account uuid", "title": "Bank Account Id" }, "description": "Bank account uuid" }, { "name": "bank_connection_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "description": "Bank connection uuid", "title": "Bank Connection Id" }, "description": "Bank connection uuid" }, { "name": "transaction_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "description": "Transaction uuid", "title": "Transaction Id" }, "description": "Transaction uuid" }, { "name": "consumer_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 2, "maxLength": 100, "description": "Unique ID of the consumer that you have registered when the user was onboarded.", "title": "Consumer Id" }, "description": "Unique ID of the consumer that you have registered when the user was onboarded." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionOutSchema" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "message": "Bad Request" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "message": "Missing or invalid Authorization Header." } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "message": "You don’t have permission to access this resource." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "message": "Resource Not Found" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "message": "Conflict error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "message": "Internal Server Error" } } } } } }, "put": { "tags": [ "Atomic Transaction" ], "summary": "Update transaction", "description": "Update the `transaction_id` transaction on `account_id` linked to `bank_connection_id` bank connection for consumer `consumer_id`.", "operationId": "put--consumers-consumer_id-banks-bank_connection_id-accounts-bank_account_id-transactions-transaction_id", "security": [ { "Authentication Token": [] } ], "parameters": [ { "name": "bank_account_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "description": "Bank account uuid", "title": "Bank Account Id" }, "description": "Bank account uuid" }, { "name": "bank_connection_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "description": "Bank connection uuid", "title": "Bank Connection Id" }, "description": "Bank connection uuid" }, { "name": "transaction_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "description": "Transaction uuid", "title": "Transaction Id" }, "description": "Transaction uuid" }, { "name": "consumer_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 2, "maxLength": 100, "description": "Unique ID of the consumer that you have registered when the user was onboarded.", "title": "Consumer Id" }, "description": "Unique ID of the consumer that you have registered when the user was onboarded." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionUpdateSchema" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionOutSchema" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "message": "Bad Request" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "message": "Missing or invalid Authorization Header." } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "message": "You don’t have permission to access this resource." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "message": "Resource Not Found" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "message": "Conflict error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "message": "Internal Server Error" } } } } } }, "delete": { "tags": [ "Atomic Transaction" ], "summary": "Delete transaction", "description": "Delete the transaction `transaction_id` on account `account_id` linked to bank connection `bank_connection_id` for consumer `consumer_id`.", "operationId": "delete--consumers-consumer_id-banks-bank_connection_id-accounts-bank_account_id-transactions-transaction_id", "security": [ { "Authentication Token": [] } ], "parameters": [ { "name": "bank_account_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "description": "Bank account uuid", "title": "Bank Account Id" }, "description": "Bank account uuid" }, { "name": "bank_connection_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "description": "Bank connection uuid", "title": "Bank Connection Id" }, "description": "Bank connection uuid" }, { "name": "transaction_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "description": "Transaction uuid", "title": "Transaction Id" }, "description": "Transaction uuid" }, { "name": "consumer_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 2, "maxLength": 100, "description": "Unique ID of the consumer that you have registered when the user was onboarded.", "title": "Consumer Id" }, "description": "Unique ID of the consumer that you have registered when the user was onboarded." } ], "responses": { "204": { "description": "Successful Response" }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "message": "Bad Request" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "message": "Missing or invalid Authorization Header." } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "message": "You don’t have permission to access this resource." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "message": "Resource Not Found" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "message": "Conflict error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "message": "Internal Server Error" } } } } } } }, "/consumers": { "post": { "tags": [ "Consumers" ], "summary": "Onboard a consumer on Paylead platform", "description": "Create a consumer by providing it's `consumer_id`", "operationId": "post--consumers", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumerCreateSchema" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumerOutSchema" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "message": "Bad Request" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "message": "Missing or invalid Authorization Header." } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "message": "You don’t have permission to access this resource." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "message": "Internal Server Error" } } } } }, "security": [ { "Authentication Token": [] } ] } } }, "components": { "schemas": { "BankAccountCreateSchema": { "properties": { "bic": { "anyOf": [ { "type": "string", "maxLength": 11, "minLength": 8, "pattern": "[A-Z0-9]{4}[A-Z]{2}[A-Z0-9]{2}(:?[A-Z0-9]{3})?", "title": "BIC" }, { "type": "null" } ], "title": "Bic" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAD", "XAF", "XCD", "XCG", "XOF", "XPF", "XSU", "XUA", "YER", "ZAR", "ZMW", "ZWG" ], "maxLength": 3, "minLength": 3, "title": "Currency", "description": "ISO 4217 currency code (alpha-3 or numeric)", "default": "EUR", "examples": [ "EUR", "978" ] }, "iban": { "anyOf": [ { "type": "string", "maxLength": 34, "title": "IBAN" }, { "type": "null" } ], "title": "Iban" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "type": { "$ref": "#/components/schemas/BankAccountType", "default": "compte_courant" } }, "type": "object", "title": "BankAccountCreateSchema" }, "BankAccountOutSchema": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "UUID of the bank account" }, "external_id": { "anyOf": [ { "type": "string", "description": "Unique identifier for the resource on your system" }, { "type": "null" } ], "title": "External Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "bic": { "anyOf": [ { "type": "string", "title": "BIC" }, { "type": "null" } ], "title": "Bic" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAD", "XAF", "XCD", "XCG", "XOF", "XPF", "XSU", "XUA", "YER", "ZAR", "ZMW", "ZWG" ], "maxLength": 3, "minLength": 3, "title": "Currency", "description": "ISO 4217 currency code (alpha-3 or numeric)", "examples": [ "EUR", "978" ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" }, "iban": { "anyOf": [ { "type": "string", "title": "IBAN" }, { "type": "null" } ], "title": "Iban" } }, "type": "object", "required": [ "id", "external_id", "bic", "currency", "type", "iban" ], "title": "BankAccountOutSchema" }, "BankAccountType": { "type": "string", "enum": [ "inconnu", "compte_courant", "compte_epargne", "compte_de_depots", "compte_de_prets", "compte_titres", "comptes_joint", "compte_carte", "assurance_vie", "plan_epargne_entreprise", "plan_epargne_retraite", "article_83", "reserve_speciale_de_participation", "plan_d_epargne_en_actions", "contrat_de_capitalisation", "plan_epargne_retraite_populaire", "contrat_retraite_madelin", "credit_immobilier", "credit_a_la_consommation", "credit_renouvelable" ], "title": "BankAccountType" }, "BankAccountUpdateSchema": { "properties": { "bic": { "anyOf": [ { "type": "string", "maxLength": 11, "minLength": 8, "pattern": "[A-Z0-9]{4}[A-Z]{2}[A-Z0-9]{2}(:?[A-Z0-9]{3})?", "title": "BIC" }, { "type": "null" } ], "title": "Bic" }, "currency": { "anyOf": [ { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAD", "XAF", "XCD", "XCG", "XOF", "XPF", "XSU", "XUA", "YER", "ZAR", "ZMW", "ZWG" ], "maxLength": 3, "minLength": 3, "description": "ISO 4217 currency code (alpha-3 or numeric)", "examples": [ "EUR", "978" ] }, { "type": "null" } ], "title": "Currency" }, "iban": { "anyOf": [ { "type": "string", "maxLength": 34, "title": "IBAN" }, { "type": "null" } ], "title": "Iban" }, "type": { "anyOf": [ { "$ref": "#/components/schemas/BankAccountType" }, { "type": "null" } ] } }, "type": "object", "title": "BankAccountUpdateSchema" }, "BankConnectionCreateSchema": { "properties": { "bank_id": { "type": "string", "format": "uuid", "title": "Bank Id" } }, "type": "object", "required": [ "bank_id" ], "title": "BankConnectionCreateSchema" }, "BankConnectionOutSchema": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "bank_id": { "type": "string", "format": "uuid", "title": "Bank Id" } }, "type": "object", "required": [ "id", "name", "bank_id" ], "title": "BankConnectionOutSchema" }, "BankConnectionStatus": { "type": "string", "enum": [ "UNKNOWN", "DISABLED", "ERROR", "CHALLENGE_REQUIRED", "SCRAPPING", "SUCCESS", "SCA_REQUIRED", "WEBAUTH_REQUIRED", "WRONG_PASS", "ACTION_NEEDED", "WAITING_FOR_VALIDATION" ], "title": "BankConnectionStatus", "description": "Bank Connection Status enum" }, "BankOutSchema": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "country_code": { "type": "string", "pattern": "^\\w{2}$", "title": "Country Code" } }, "type": "object", "required": [ "id", "name", "country_code" ], "title": "BankOutSchema" }, "BrandSchema": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "mcc": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mcc" }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "post_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Post Code" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" }, "category_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category Code" }, "public_reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Public Reference" } }, "type": "object", "title": "BrandSchema" }, "BucketAccountSchema": { "properties": { "id": { "type": "string", "title": "Id", "description": "Unique identifier for the resource on your system" }, "iban": { "anyOf": [ { "type": "string", "maxLength": 34, "title": "IBAN" }, { "type": "null" } ], "title": "Iban" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "transactions": { "items": { "$ref": "#/components/schemas/BucketTransactionSchema" }, "type": "array", "title": "Transactions", "default": [] } }, "type": "object", "required": [ "id" ], "title": "BucketAccountSchema" }, "BucketBankSchema": { "properties": { "id": { "anyOf": [ { "type": "string", "description": "Unique identifier for the resource on your system" }, { "type": "null" } ], "title": "Id" }, "bank_id": { "type": "string", "title": "Bank Id" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/BankConnectionStatus" }, { "type": "null" } ] }, "accounts": { "items": { "$ref": "#/components/schemas/BucketAccountSchema" }, "type": "array", "title": "Accounts" } }, "type": "object", "required": [ "bank_id", "accounts" ], "title": "BucketBankSchema" }, "BucketCreateSchema": { "properties": { "banks": { "items": { "$ref": "#/components/schemas/BucketBankSchema" }, "type": "array", "title": "Banks", "examples": [ [ { "accounts": [ { "iban": "FR7630006000011234567890189", "id": "acc_9876543210", "name": "exemple_account", "transactions": [ { "account_id": "acc_9876543210", "amount": -85.5, "authorization_id_response": "1A2B3C", "brand": { "address": "1 Rue de la Paix", "category_code": "CLOTHING", "city": "Paris", "country": "FR", "id": "brand_nike", "mcc": "5941", "name": "Nike", "post_code": "75001", "public_reference": "FR0123456789" }, "category": "shopping", "channel": "in_store", "currency": "EUR", "executed_at": "2023-07-15T14:32:45", "id": "tx_12345678abcdef", "is_realtime": true, "label": "PURCHASE NIKE STORE", "raw_label": "PURCHASE NIKE STORE PARIS", "retrieval_reference_number": "1A2B3C1A2B3C", "scheme": "visa", "state": "completed", "store": { "address": "1 Rue de la Paix", "category_code": "Clothing", "city": "Paris", "country": "FR", "id": "store_123456", "merchant_id": "merchant_nike_fr", "name": "Nike Store", "post_code": "75001", "public_reference": "RCS987654321" }, "truncated_dpan": "1234", "truncated_pan": "1234", "type": "card_payment" } ] } ], "bank_id": "bank_id", "id": "1", "status": "SUCCESS" } ] ] } }, "type": "object", "required": [ "banks" ], "title": "BucketCreateSchema" }, "BucketTransactionSchema": { "properties": { "id": { "type": "string", "title": "Id", "description": "Unique identifier for the resource on your system" }, "account_id": { "anyOf": [ { "type": "string", "description": "Unique identifier for the resource on your system" }, { "type": "null" } ], "title": "Account Id" }, "amount": { "type": "number", "title": "Amount" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" }, "raw_label": { "type": "string", "title": "Raw Label", "description": "Unicode string that must not contain null bytes (\\x00)" }, "executed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ], "title": "Executed At" }, "type": { "$ref": "#/components/schemas/TransactionType" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" }, "deleted": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Deleted" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAD", "XAF", "XCD", "XCG", "XOF", "XPF", "XSU", "XUA", "YER", "ZAR", "ZMW", "ZWG" ], "maxLength": 3, "minLength": 3, "title": "Currency", "description": "ISO 4217 currency code (alpha-3 or numeric)", "examples": [ "EUR", "978" ] }, "store": { "anyOf": [ { "$ref": "#/components/schemas/StoreSchema" }, { "type": "null" } ] }, "brand": { "anyOf": [ { "$ref": "#/components/schemas/BrandSchema" }, { "type": "null" } ] }, "state": { "anyOf": [ { "$ref": "#/components/schemas/TransactionState" }, { "type": "null" } ] }, "channel": { "anyOf": [ { "$ref": "#/components/schemas/TransactionChannel" }, { "type": "null" } ] }, "is_realtime": { "type": "boolean", "title": "Is Realtime", "default": false }, "truncated_pan": { "anyOf": [ { "type": "string", "description": "Last 4 digits of the card number, must be a string without null bytes, and match 4 digits" }, { "type": "null" } ], "title": "Truncated Pan" }, "truncated_dpan": { "anyOf": [ { "type": "string", "description": "Last 4 digits of the device token, must be a string without null bytes, and match 4 digits" }, { "type": "null" } ], "title": "Truncated Dpan" }, "scheme": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheme", "description": "The network used for the transaction", "examples": [ "visa", "mastercard" ] }, "authorization_id_response": { "anyOf": [ { "type": "string", "maxLength": 6, "minLength": 1, "description": "Alphanumeric reference number assigned by the issuer in response to a transaction authorization request.", "example": "1A2B3C" }, { "type": "null" } ], "title": "Authorization Id Response" }, "retrieval_reference_number": { "anyOf": [ { "type": "string", "maxLength": 12, "minLength": 1, "pattern": "^[a-zA-Z0-9 ]{1,12}$", "description": "Alphanumeric retrieval reference number, unique identifier assigned to a card transaction during the authorization", "example": "1A2B3C4D5E6F" }, { "type": "null" } ], "title": "Retrieval Reference Number" } }, "type": "object", "required": [ "id", "amount", "raw_label", "executed_at", "type", "currency" ], "title": "BucketTransactionSchema" }, "ConsumerCreateSchema": { "properties": { "id": { "type": "string", "maxLength": 100, "minLength": 2, "title": "Id", "description": "Unique identifier for a consumer on your system, alphanumeric string with optional dashes or underscores" }, "banks": { "anyOf": [ { "items": { "$ref": "#/components/schemas/BucketBankSchema" }, "type": "array" }, { "type": "null" } ], "title": "Banks" } }, "type": "object", "required": [ "id" ], "title": "ConsumerCreateSchema" }, "ConsumerOutSchema": { "properties": { "id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]+$", "title": "Id", "description": "Unique identifier for a consumer on your system, alphanumeric string with optional dashes or underscores" } }, "type": "object", "required": [ "id" ], "title": "ConsumerOutSchema" }, "EmptySchema": { "properties": {}, "type": "object", "title": "EmptySchema" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "PayLeadLinks": { "properties": { "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First", "examples": [ "/api/example?page=1&per_page=50" ] }, "last": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last", "examples": [ "/api/example?page=5&per_page=50" ] }, "self": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Self", "examples": [ "/api/example?page=3&per_page=50" ] }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next", "examples": [ "/api/example?page=4&per_page=50" ] }, "prev": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prev", "examples": [ "/api/example?page=2&per_page=50" ] } }, "type": "object", "required": [ "first", "last", "self", "next", "prev" ], "title": "PayLeadLinks" }, "PayleadPageMeta": { "properties": { "page": { "type": "integer", "title": "Page", "default": 1 }, "per_page": { "type": "integer", "title": "Per Page", "default": 50 }, "total": { "type": "integer", "title": "Total", "default": 1000 }, "links": { "$ref": "#/components/schemas/PayLeadLinks" } }, "type": "object", "required": [ "links" ], "title": "PayleadPageMeta" }, "StoreSchema": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "post_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Post Code" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "category_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category Code" }, "public_reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Public Reference" }, "merchant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Merchant Id" } }, "type": "object", "title": "StoreSchema" }, "TransactionChannel": { "type": "string", "enum": [ "store", "online" ], "title": "TransactionChannel" }, "TransactionCreateSchema": { "properties": { "id": { "type": "string", "title": "Id", "description": "Unique identifier for the resource on your system" }, "amount": { "type": "number", "title": "Amount" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAD", "XAF", "XCD", "XCG", "XOF", "XPF", "XSU", "XUA", "YER", "ZAR", "ZMW", "ZWG" ], "maxLength": 3, "minLength": 3, "title": "Currency", "description": "ISO 4217 currency code (alpha-3 or numeric)", "examples": [ "EUR", "978" ] }, "executed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ], "title": "Executed At" }, "type": { "$ref": "#/components/schemas/TransactionType" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" }, "raw_label": { "type": "string", "title": "Raw Label", "description": "Unicode string that must not contain null bytes (\\x00)" }, "truncated_pan": { "anyOf": [ { "type": "string", "description": "Last 4 digits of the card number, must be a string without null bytes, and match 4 digits" }, { "type": "null" } ], "title": "Truncated Pan" }, "country_code": { "anyOf": [ { "type": "string", "pattern": "^\\w{2}$" }, { "type": "null" } ], "title": "Country Code" }, "brand": { "anyOf": [ { "$ref": "#/components/schemas/BrandSchema" }, { "type": "null" } ] }, "store": { "anyOf": [ { "$ref": "#/components/schemas/StoreSchema" }, { "type": "null" } ] }, "state": { "anyOf": [ { "$ref": "#/components/schemas/TransactionState" }, { "type": "null" } ] }, "channel": { "anyOf": [ { "$ref": "#/components/schemas/TransactionChannel" }, { "type": "null" } ] }, "scheme": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheme", "description": "The network used for the transaction", "examples": [ "visa", "mastercard" ] }, "authorization_id_response": { "anyOf": [ { "type": "string", "maxLength": 6, "minLength": 1, "description": "Alphanumeric reference number assigned by the issuer in response to a transaction authorization request.", "example": "1A2B3C" }, { "type": "null" } ], "title": "Authorization Id Response" }, "retrieval_reference_number": { "anyOf": [ { "type": "string", "maxLength": 12, "minLength": 1, "pattern": "^[a-zA-Z0-9 ]{1,12}$", "description": "Alphanumeric retrieval reference number, unique identifier assigned to a card transaction during the authorization", "example": "1A2B3C4D5E6F" }, { "type": "null" } ], "title": "Retrieval Reference Number" }, "truncated_dpan": { "anyOf": [ { "type": "string", "description": "Last 4 digits of the device token, must be a string without null bytes, and match 4 digits" }, { "type": "null" } ], "title": "Truncated Dpan" } }, "type": "object", "required": [ "id", "amount", "currency", "executed_at", "type", "raw_label" ], "title": "TransactionCreateSchema" }, "TransactionOutSchema": { "properties": { "id": { "type": "string", "title": "Id", "description": "Unique identifier for the resource on your system" }, "amount": { "type": "number", "title": "Amount" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAD", "XAF", "XCD", "XCG", "XOF", "XPF", "XSU", "XUA", "YER", "ZAR", "ZMW", "ZWG" ], "maxLength": 3, "minLength": 3, "title": "Currency", "description": "ISO 4217 currency code (alpha-3 or numeric)", "examples": [ "EUR", "978" ] }, "is_realtime": { "type": "boolean", "title": "Is Realtime", "default": false }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" }, "raw_label": { "type": "string", "title": "Raw Label", "description": "Unicode string that must not contain null bytes (\\x00)" }, "truncated_pan": { "anyOf": [ { "type": "string", "description": "Last 4 digits of the card number, must be a string without null bytes, and match 4 digits" }, { "type": "null" } ], "title": "Truncated Pan" }, "country_code": { "anyOf": [ { "type": "string", "pattern": "^\\w{2}$" }, { "type": "null" } ], "title": "Country Code" }, "executed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ], "title": "Executed At" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/TransactionState" }, { "type": "null" } ] }, "channel": { "anyOf": [ { "$ref": "#/components/schemas/TransactionChannel" }, { "type": "null" } ] }, "type": { "$ref": "#/components/schemas/TransactionType" }, "brand": { "anyOf": [ { "$ref": "#/components/schemas/BrandSchema" }, { "type": "null" } ] }, "store": { "anyOf": [ { "$ref": "#/components/schemas/StoreSchema" }, { "type": "null" } ] }, "scheme": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheme", "description": "The network used for the transaction", "examples": [ "visa", "mastercard" ] }, "authorization_id_response": { "anyOf": [ { "type": "string", "pattern": "^[a-zA-Z0-9]{1,6}$", "description": "Alphanumeric reference number assigned by the issuer in response to a transaction authorization request.", "example": "1A2B3C" }, { "type": "null" } ], "title": "Authorization Id Response" }, "retrieval_reference_number": { "anyOf": [ { "type": "string", "maxLength": 12, "minLength": 1, "pattern": "^[a-zA-Z0-9 ]{1,12}$", "description": "Alphanumeric retrieval reference number, unique identifier assigned to a card transaction during the authorization", "example": "1A2B3C4D5E6F" }, { "type": "null" } ], "title": "Retrieval Reference Number" }, "truncated_dpan": { "anyOf": [ { "type": "string", "description": "Last 4 digits of the device token, must be a string without null bytes, and match 4 digits" }, { "type": "null" } ], "title": "Truncated Dpan" } }, "type": "object", "required": [ "id", "amount", "currency", "raw_label", "executed_at", "type" ], "title": "TransactionOutSchema" }, "TransactionState": { "type": "string", "enum": [ "cleared", "authorization" ], "title": "TransactionState" }, "TransactionType": { "type": "string", "enum": [ "bank", "card", "check", "deferred_card", "deposit", "loan_payment", "order", "payback", "summary_card", "transfer", "unknown", "withdrawal" ], "title": "TransactionType" }, "TransactionUpdateSchema": { "properties": { "id": { "type": "string", "title": "Id", "description": "Unique identifier for the resource on your system" }, "amount": { "type": "number", "title": "Amount" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAD", "XAF", "XCD", "XCG", "XOF", "XPF", "XSU", "XUA", "YER", "ZAR", "ZMW", "ZWG" ], "maxLength": 3, "minLength": 3, "title": "Currency", "description": "ISO 4217 currency code (alpha-3 or numeric)", "examples": [ "EUR", "978" ] }, "executed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ], "title": "Executed At" }, "type": { "$ref": "#/components/schemas/TransactionType" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" }, "raw_label": { "type": "string", "title": "Raw Label", "description": "Unicode string that must not contain null bytes (\\x00)" }, "truncated_pan": { "anyOf": [ { "type": "string", "description": "Last 4 digits of the card number, must be a string without null bytes, and match 4 digits" }, { "type": "null" } ], "title": "Truncated Pan" }, "country_code": { "anyOf": [ { "type": "string", "pattern": "^\\w{2}$" }, { "type": "null" } ], "title": "Country Code" }, "brand": { "anyOf": [ { "$ref": "#/components/schemas/BrandSchema" }, { "type": "null" } ] }, "store": { "anyOf": [ { "$ref": "#/components/schemas/StoreSchema" }, { "type": "null" } ] }, "state": { "anyOf": [ { "$ref": "#/components/schemas/TransactionState" }, { "type": "null" } ] }, "channel": { "anyOf": [ { "$ref": "#/components/schemas/TransactionChannel" }, { "type": "null" } ] }, "scheme": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheme", "description": "The network used for the transaction", "examples": [ "visa", "mastercard" ] }, "authorization_id_response": { "anyOf": [ { "type": "string", "maxLength": 6, "minLength": 1, "description": "Alphanumeric reference number assigned by the issuer in response to a transaction authorization request.", "example": "1A2B3C" }, { "type": "null" } ], "title": "Authorization Id Response" }, "retrieval_reference_number": { "anyOf": [ { "type": "string", "maxLength": 12, "minLength": 1, "pattern": "^[a-zA-Z0-9 ]{1,12}$", "description": "Alphanumeric retrieval reference number, unique identifier assigned to a card transaction during the authorization", "example": "1A2B3C4D5E6F" }, { "type": "null" } ], "title": "Retrieval Reference Number" }, "truncated_dpan": { "anyOf": [ { "type": "string", "description": "Last 4 digits of the device token, must be a string without null bytes, and match 4 digits" }, { "type": "null" } ], "title": "Truncated Dpan" }, "is_realtime": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Realtime" } }, "type": "object", "required": [ "id", "amount", "currency", "executed_at", "type", "raw_label" ], "title": "TransactionUpdateSchema" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "_PayleadPage_BankAccountOutSchema_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/BankAccountOutSchema" }, "type": "array", "title": "Items" }, "meta": { "$ref": "#/components/schemas/PayleadPageMeta" } }, "type": "object", "required": [ "items", "meta" ], "title": "_PayleadPage[BankAccountOutSchema]" }, "_PayleadPage_BankConnectionOutSchema_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/BankConnectionOutSchema" }, "type": "array", "title": "Items" }, "meta": { "$ref": "#/components/schemas/PayleadPageMeta" } }, "type": "object", "required": [ "items", "meta" ], "title": "_PayleadPage[BankConnectionOutSchema]" }, "_PayleadPage_BankOutSchema_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/BankOutSchema" }, "type": "array", "title": "Items" }, "meta": { "$ref": "#/components/schemas/PayleadPageMeta" } }, "type": "object", "required": [ "items", "meta" ], "title": "_PayleadPage[BankOutSchema]" }, "_PayleadPage_TransactionOutSchema_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/TransactionOutSchema" }, "type": "array", "title": "Items" }, "meta": { "$ref": "#/components/schemas/PayleadPageMeta" } }, "type": "object", "required": [ "items", "meta" ], "title": "_PayleadPage[TransactionOutSchema]" } }, "securitySchemes": { "Authentication Token": { "type": "http", "description": "\nEnter your \"Injector\" API Key\n\nSee Authentication section for more information\n ", "scheme": "bearer" } } }, "tags": [ { "name": "Health", "description": "Route used to health-check the app" }, { "name": "Consumers", "description": "Routes used to query consumers resources" }, { "name": "Bank", "description": "Routes used to query banks resources" }, { "name": "Bank Connection", "description": "Routes used to query banks connections resources" }, { "name": "Bank Account", "description": "Routes used to query bank account resources" }, { "name": "Bulk Transaction", "description": "Routes used to create transactions with a bulk insert" }, { "name": "Transaction", "description": "Routes used to query transactions resources based on the transaction id or unique id that you defined" }, { "name": "Atomic Transaction", "description": "Routes used to query transactions resources based on the bank connection id, bank account id and transaction id" } ] }