{ "openapi":"3.0.0", "paths":{ "/v1/auth/signin":{ "post":{ "description":"Generate an Access Token by providing your API ID and API Key in the request body. Use the Access Token to authenticate and log in to the application via the 'Authorize' section.", "operationId":"V1LoginAuthRestController_execute_v1", "parameters":[ { "name":"nonce", "in":"header", "description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ", "required":true, "schema":{ "type":"string" } }, { "name":"x-lang", "in":"header", "description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ", "required":false, "schema":{ "type":"string", "enum":[ "pt-BR", "en-US" ] } }, { "name":"x-product-uuid", "in":"header", "description":"The product ID is a UUID (v4) used to identify the Z.ro \n product configuration.\n ", "required":false, "schema":{ "type":"string" } }, { "name":"x-product-target-user-uuid", "in":"header", "description":"The product target user ID is a UUID (v4) used to identify \n what user account this request must be executed.\n Require: x-product-uuid. \n ", "required":false, "schema":{ "type":"string" } } ], "requestBody":{ "required":true, "description":"Create an Access Token requires an API ID and Api Key.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/V1AuthenticateRestRequest" } } } }, "responses":{ "200":{ "description":"User authenticated successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AuthenticateRestResponse" } } } }, "400":{ "description":"If any required params are missing or has invalid format or type." }, "401":{ "description":"User authentication failed." } }, "summary":"Create Access Token for Login", "tags":[ "Authentication" ] } }, "/v1/auth/refresh-token":{ "post":{ "description":"Refresh the user's access token by providing the old access token in the request header. A new access token will be generated upon successful authentication.", "operationId":"V1RefreshTokenAuthRestController_execute_v1", "parameters":[ { "name":"x-access-token", "in":"header", "description":"Send expired jwt access token with refresh token inside.", "required":true, "schema":{ "type":"string" } }, { "name":"nonce", "in":"header", "description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ", "required":true, "schema":{ "type":"string" } }, { "name":"x-lang", "in":"header", "description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ", "required":false, "schema":{ "type":"string", "enum":[ "pt-BR", "en-US" ] } }, { "name":"x-product-uuid", "in":"header", "description":"The product ID is a UUID (v4) used to identify the Z.ro \n product configuration.\n ", "required":false, "schema":{ "type":"string" } }, { "name":"x-product-target-user-uuid", "in":"header", "description":"The product target user ID is a UUID (v4) used to identify \n what user account this request must be executed.\n Require: x-product-uuid. \n ", "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"User authenticated successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RefreshTokenRestResponse" } } } }, "400":{ "description":"If any required params are missing or has invalid format or type." }, "401":{ "description":"User authentication failed." } }, "summary":"Refresh Access Token", "tags":[ "Authentication" ] } }, "/health":{ "get":{ "operationId":"HealthController_execute", "parameters":[ ], "responses":{ "200":{ "description":"The Health Check is successful", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "status":{ "type":"string", "example":"ok" }, "info":{ "type":"object", "example":{ "database":{ "status":"up" } }, "additionalProperties":{ "type":"object", "required":[ "status" ], "properties":{ "status":{ "type":"string" } }, "additionalProperties":true }, "nullable":true }, "error":{ "type":"object", "example":{ }, "additionalProperties":{ "type":"object", "required":[ "status" ], "properties":{ "status":{ "type":"string" } }, "additionalProperties":true }, "nullable":true }, "details":{ "type":"object", "example":{ "database":{ "status":"up" } }, "additionalProperties":{ "type":"object", "required":[ "status" ], "properties":{ "status":{ "type":"string" } }, "additionalProperties":true } } } } } } }, "503":{ "description":"The Health Check is not successful", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "status":{ "type":"string", "example":"error" }, "info":{ "type":"object", "example":{ "database":{ "status":"up" } }, "additionalProperties":{ "type":"object", "required":[ "status" ], "properties":{ "status":{ "type":"string" } }, "additionalProperties":true }, "nullable":true }, "error":{ "type":"object", "example":{ "redis":{ "status":"down", "message":"Could not connect" } }, "additionalProperties":{ "type":"object", "required":[ "status" ], "properties":{ "status":{ "type":"string" } }, "additionalProperties":true }, "nullable":true }, "details":{ "type":"object", "example":{ "database":{ "status":"up" }, "redis":{ "status":"down", "message":"Could not connect" } }, "additionalProperties":{ "type":"object", "required":[ "status" ], "properties":{ "status":{ "type":"string" } }, "additionalProperties":true } } } } } } } }, "summary":"Health Check", "tags":[ "Health" ] } }, "/v1/payin/{id}":{ "get":{ "description":"Tag: api-payments-gateway-get-payin-by-id
\n Description: Retrieve payin details by its unique ID.", "operationId":"V1GetPayinByIdRestController_execute_v1", "parameters":[ { "name":"x-wallet-uuid", "in":"header", "description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)", "schema":{ "type":"string" } }, { "name":"nonce", "in":"header", "description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ", "required":true, "schema":{ "type":"string" } }, { "name":"x-lang", "in":"header", "description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ", "required":false, "schema":{ "type":"string", "enum":[ "pt-BR", "en-US" ] } }, { "name":"x-product-uuid", "in":"header", "description":"The product ID is a UUID (v4) used to identify the Z.ro \n product configuration.\n ", "required":false, "schema":{ "type":"string" } }, { "name":"x-product-target-user-uuid", "in":"header", "description":"The product target user ID is a UUID (v4) used to identify \n what user account this request must be executed.\n Require: x-product-uuid. \n ", "required":false, "schema":{ "type":"string" } }, { "name":"type", "required":true, "in":"query", "description":"Payment method type", "schema":{ "enum":[ "CREDIT_CARD", "DEBIT_CARD", "CASH", "BANK_TRANSFER" ], "type":"string" } }, { "name":"id", "required":true, "in":"path", "description":"Payin ID", "schema":{ "example":"105c1f71-8663-7e2d-aa28-c7872562bdaf", "type":"string" } } ], "responses":{ "200":{ "description":"Payin details retrieved successfully.", "content":{ "application/json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/V1GetAcquiringPaymentByIdResponse" }, { "$ref":"#/components/schemas/V1GetCashDepositByIdResponse" }, { "$ref":"#/components/schemas/V1GetBankTransferDepositByIdResponse" } ] }, "examples":{ "acquiring":{ "summary":"Acquiring details" }, "cashDeposit":{ "summary":"Cash deposit details" }, "bankTransfer":{ "summary":"Bank Transfer details" } } } } }, "400":{ "description":"If any required params are missing or has invalid format or type." }, "401":{ "description":"User authentication failed." }, "422":{ "description":"If any required params are missing or has invalid format or type." } }, "security":[ { "bearer":[ ] } ], "summary":"Get payin by ID", "tags":[ "Payin" ] }, "delete":{ "description":"Tag: api-payments-gateway-delete-payin
\n Description: Cancel an existing payin. (Only CREDIT_CARD for the moment)
", "operationId":"V1CancelPayinRestController_execute_v1", "parameters":[ { "name":"x-wallet-uuid", "in":"header", "description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)", "schema":{ "type":"string" } }, { "name":"nonce", "in":"header", "description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ", "required":true, "schema":{ "type":"string" } }, { "name":"x-lang", "in":"header", "description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ", "required":false, "schema":{ "type":"string", "enum":[ "pt-BR", "en-US" ] } }, { "name":"x-product-uuid", "in":"header", "description":"The product ID is a UUID (v4) used to identify the Z.ro \n product configuration.\n ", "required":false, "schema":{ "type":"string" } }, { "name":"x-product-target-user-uuid", "in":"header", "description":"The product target user ID is a UUID (v4) used to identify \n what user account this request must be executed.\n Require: x-product-uuid. \n ", "required":false, "schema":{ "type":"string" } }, { "name":"id", "required":true, "in":"path", "description":"Payin ID.", "schema":{ "example":"0197b169-da6b-7ba2-b053-ce413ae39afd", "type":"string" } }, { "name":"payment_method", "required":true, "in":"query", "description":"Payment Method.", "schema":{ "example":"CREDIT_CARD", "enum":[ "CREDIT_CARD" ], "type":"string" } } ], "responses":{ "200":{ "description":"Payin canceled successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/V1CancelPayinRestResponse" } } } }, "400":{ "description":"If any required params are missing or has invalid format or type." }, "422":{ "description":"If any required params are missing or has invalid format or type." } }, "security":[ { "bearer":[ ] } ], "summary":"Cancel Payin", "tags":[ "Payin" ] } }, "/v1/payin":{ "get":{ "description":"Tag: api-payments-gateway-get-payin-all
\n Description: Retrieve all payins for the authenticated user by payment type with optional country filter and pagination.", "operationId":"V1GetAllPayinsRestController_execute_v1", "parameters":[ { "name":"x-wallet-uuid", "in":"header", "description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)", "schema":{ "type":"string" } }, { "name":"nonce", "in":"header", "description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ", "required":true, "schema":{ "type":"string" } }, { "name":"x-lang", "in":"header", "description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ", "required":false, "schema":{ "type":"string", "enum":[ "pt-BR", "en-US" ] } }, { "name":"x-product-uuid", "in":"header", "description":"The product ID is a UUID (v4) used to identify the Z.ro \n product configuration.\n ", "required":false, "schema":{ "type":"string" } }, { "name":"x-product-target-user-uuid", "in":"header", "description":"The product target user ID is a UUID (v4) used to identify \n what user account this request must be executed.\n Require: x-product-uuid. \n ", "required":false, "schema":{ "type":"string" } }, { "name":"sort", "required":false, "in":"query", "description":"Page sort attribute.", "schema":{ "type":"string" } }, { "name":"page", "required":false, "in":"query", "description":"Page number, starting from 1. Default is 1.", "schema":{ "example":1, "type":"number" } }, { "name":"country", "required":false, "in":"query", "schema":{ "enum":[ "BRA", "ARG", "CHL", "PER" ], "type":"string" } }, { "name":"type", "required":true, "in":"query", "description":"Payment type filter. Use CREDIT_CARD or DEBIT_CARD for card payments, CASH for cash payments, or BANK_TRANSFER for bank transfer deposits.", "schema":{ "enum":[ "CREDIT_CARD", "DEBIT_CARD", "CASH", "BANK_TRANSFER" ], "type":"string" } } ], "responses":{ "200":{ "description":"Payins retrieved successfully.", "content":{ "application/json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/V1GetAllAcquiringPaymentsResponse" }, { "$ref":"#/components/schemas/V1GetAllCashDepositsResponse" }, { "$ref":"#/components/schemas/V1GetAllBankTransferDepositsResponse" } ] }, "examples":{ "acquiring":{ "summary":"Acquiring Payments Response (type=ACQUIRING)", "value":{ "page":1, "page_size":20, "page_total":5, "total":100, "data":[ { "id":"0197b169-da6b-7ba2-b053-ce413ae39afd", "user_id":"123e4567-e89b-12d3-a456-426614174000", "operation_id":"456e7890-e12b-34d5-a678-426614174001", "wallet_id":"789e0123-e45b-67d8-a901-426614174002", "country":"BR", "sales_channel":"INTEGRATION", "payment_method":"CREDIT_CARD", "amount":10000, "currency_tag":"BRL", "status":"AUTHORIZED", "third_part_name":"John Doe", "third_part_email":"john.doe@example.com", "third_part_phone_number":"+5511999998888", "third_part_document_type":"CPF", "third_part_document":"12345678901", "third_part_address_city":"São Paulo", "third_part_address_country":"BR", "third_part_address_state":"SP", "third_part_address_number":"123", "third_part_address_street":"Avenida Paulista", "third_part_address_zip_code":"01311000", "third_part_address_complement":"Apto 101", "card_last_four_digits":"1234", "installments":1, "authorized_date":"2023-01-01T12:00:00.000Z", "declined_date":null, "cancelled_date":null, "settlement_date":"2023-01-02T12:00:00.000Z", "cancelled_max_date":null, "expected_settlement_date":"2023-01-02T12:00:00.000Z", "refunded_date":null, "created_at":"2023-01-01T10:00:00.000Z", "updated_at":"2023-01-01T11:00:00.000Z" } ] } }, "cash":{ "summary":"Cash Deposits Response (type=CASH)", "value":{ "page":1, "page_size":20, "page_total":3, "total":50, "data":[ { "id":"0197b169-da6b-7ba2-b053-ce413ae39afd", "operation_id":"456e7890-e12b-34d5-a678-426614174001", "country":"ARG", "status":"PENDING", "amount":5000, "currency_tag":"PEN", "expiration_time_minutes":10, "payment_url":"https://example.com/deposit/0197b169-da6b-7ba2-b053-ce413ae39afd", "third_part_name":"Jane", "third_part_last_name":"Smith", "third_part_email":"jane.smith@example.com", "third_part_phone":"+54123456789", "third_part_document":"87654321", "third_part_document_type":"DNI", "third_part_address_zip_code":"2000", "third_part_address_street":"Av. Santa Fe", "third_part_address_number":"456", "third_part_address_city":"Rosario", "third_part_address_state":"SF", "third_part_address_country":"AR", "third_part_address_complement":"Piso 2", "redirect_url":"https://example.com/success", "expiration_date":"2023-10-01T12:10:00.000Z", "authorized_date":null, "refunded_date":null, "settlement_date":null, "failed_date":null, "created_at":"2023-10-01T12:00:00.000Z", "updated_at":"2023-10-01T12:00:00.000Z" } ] } }, "bankTransfer":{ "summary":"Bank Transfer Deposits Response (type=BANK_TRANSFER)", "value":{ "page":1, "page_size":20, "page_total":2, "total":25, "data":[ { "id":"0197b169-da6b-7ba2-b053-ce413ae39afd", "user_id":"123e4567-e89b-12d3-a456-426614174000", "wallet_id":"223e4567-e89b-12d3-a456-426614174000", "operation_id":"456e7890-e12b-34d5-a678-426614174001", "country":"ARG", "status":"PENDING", "amount":10000, "currency_tag":"USD", "expiration_time_minutes":10, "payment_url":"https://bank.example.com/transfer/0197b169-da6b-7ba2-b053-ce413ae39afd", "language":"en", "third_part_name":"Carlos", "third_part_last_name":"Garcia", "third_part_email":"carlos.garcia@example.com", "third_part_phone":"+54123456789", "third_part_document":"11223344", "third_part_document_type":"DNI", "third_part_address_zip_code":"3000", "third_part_address_street":"Av. San Martin", "third_part_address_number":"789", "third_part_address_city":"Cordoba", "third_part_address_state":"CB", "third_part_address_country":"AR", "third_part_address_complement":"Depto 3B", "expiration_date":"2023-10-01T12:10:00.000Z", "authorized_date":null, "refunded_date":null, "settlement_date":null, "scheduled_settlement_date":"2023-10-02T12:00:00.000Z", "created_at":"2023-10-01T12:00:00.000Z", "updated_at":"2023-10-01T12:00:00.000Z", "redirect_url":"https://example.com/my-home-page" } ] } } } } } }, "400":{ "description":"If any required params are missing or has invalid format or type." }, "401":{ "description":"User authentication failed." }, "422":{ "description":"If any required params are missing or has invalid format or type." } }, "security":[ { "bearer":[ ] } ], "summary":"Get all payins by type", "tags":[ "Payin" ] }, "post":{ "description":"Tag: api-payments-gateway-post-payin
\n Description: Create a new payin.
", "operationId":"V1CreatePayinRestController_execute_v1", "parameters":[ { "name":"x-include-replay-protection-schema", "in":"header", "description":"The replay-protection-schema allows the user to choose between 3 options:
\n ", "schema":{ "type":"string" } }, { "name":"x-wallet-uuid", "in":"header", "description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)", "schema":{ "type":"string" } }, { "name":"x-transaction-uuid", "in":"header", "description":"The transaction ID is a UUID (v7) used to uniquely identify the object that will be created. All objects must have an identifier.", "required":true, "schema":{ "type":"string" } }, { "name":"nonce", "in":"header", "description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ", "required":true, "schema":{ "type":"string" } }, { "name":"x-lang", "in":"header", "description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ", "required":false, "schema":{ "type":"string", "enum":[ "pt-BR", "en-US" ] } }, { "name":"x-product-uuid", "in":"header", "description":"The product ID is a UUID (v4) used to identify the Z.ro \n product configuration.\n ", "required":false, "schema":{ "type":"string" } }, { "name":"x-product-target-user-uuid", "in":"header", "description":"The product target user ID is a UUID (v4) used to identify \n what user account this request must be executed.\n Require: x-product-uuid. \n ", "required":false, "schema":{ "type":"string" } } ], "requestBody":{ "required":true, "description":"Payin creation request body. Choose one of the available payin method bodies.", "content":{ "application/json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/V1CreatePayinBody" }, { "$ref":"#/components/schemas/V1CreateAcquiringCreditPaymentBody" }, { "$ref":"#/components/schemas/V1CreateAcquiringDebitPaymentBody" }, { "$ref":"#/components/schemas/V1CreateCashDepositBody" }, { "$ref":"#/components/schemas/V1CreateBankTransferDepositBody" } ], "discriminator":{ "propertyName":"payment_method", "mapping":{ "CREDIT_CARD":"#/components/schemas/V1CreateAcquiringCreditPaymentBody", "DEBIT_CARD":"#/components/schemas/V1CreateAcquiringDebitPaymentBody", "CASH":"#/components/schemas/V1CreateCashDepositBody", "BANK_TRANSFER":"#/components/schemas/V1CreateBankTransferDepositBody" } } } } } }, "responses":{ "200":{ "description":"Payin created successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/V1CreatePayinResponse" } } } }, "400":{ "description":"If any required params are missing or has invalid format or type." }, "401":{ "description":"User authentication failed." }, "422":{ "description":"If any required params are missing or has invalid format or type." } }, "security":[ { "bearer":[ ] } ], "summary":"Create Payin", "tags":[ "Payin" ] } }, "/v1/payin/three-ds/authentications":{ "post":{ "description":"\n Tag: api-payments-gateway-post-payin\n \n 3DS Authentication Flow:\n 1. Initial Request: Send card and transaction details to this endpoint.\n 2. Status Response: You'll receive one of these authentication status:\n - PENDING: Authentication is being processed.\n - WAITING_AUTHENTICATION: Internal processing, no user action needed.\n - WAITING_CHALLENGE: User needs to complete additional authentication.\n - ACCEPTED: Authentication successful.\n - REJECTED: Authentication rejected.\n - FAILED: Process error.\n \n Authentication Scenarios:\n - Frictionless: When status is ACCEPTED, don't require further user action. Proceed with payment (POST: v1/payments).\n - Challenge: When status is WAITING_CHALLENGE, redirect user to the provided challenge URL for additional verification.\n - You need to send a POST request with the Challenge URL, Authentication ID, and iframe data. The response will return the HTML content that should be rendered inside an iframe.\n ", "operationId":"V1CreateThreeDsRestController_execute_v1", "parameters":[ { "name":"x-wallet-uuid", "in":"header", "description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)", "schema":{ "type":"string" } }, { "name":"x-transaction-uuid", "in":"header", "description":"The transaction ID is a UUID (v7) used to uniquely identify the object that will be created. All objects must have an identifier.", "required":true, "schema":{ "type":"string" } }, { "name":"nonce", "in":"header", "description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ", "required":true, "schema":{ "type":"string" } }, { "name":"x-lang", "in":"header", "description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ", "required":false, "schema":{ "type":"string", "enum":[ "pt-BR", "en-US" ] } }, { "name":"x-product-uuid", "in":"header", "description":"The product ID is a UUID (v4) used to identify the Z.ro \n product configuration.\n ", "required":false, "schema":{ "type":"string" } }, { "name":"x-product-target-user-uuid", "in":"header", "description":"The product target user ID is a UUID (v4) used to identify \n what user account this request must be executed.\n Require: x-product-uuid. \n ", "required":false, "schema":{ "type":"string" } } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/V1CreateThreeDsBody" } } } }, "responses":{ "200":{ "description":"3DS Authentication created successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/V1CreateThreeDsRestResponse" } } } }, "400":{ "description":"If any required params are missing or has invalid format or type." }, "401":{ "description":"User authentication failed." }, "422":{ "description":"If any required params are missing or has invalid format or type." } }, "security":[ { "bearer":[ ] } ], "summary":"Create 3DS Authentication", "tags":[ "Payments | 3DS Authentication" ] } }, "/v1/payin/three-ds/authentications/{id}":{ "get":{ "description":"Tag: api-payments-gateway-get-3ds-authentication-by-id
\n Description: Retrieve 3DS authentication details by its unique ID.", "operationId":"V1GetThreeDsByIdRestController_execute_v1", "parameters":[ { "name":"x-wallet-uuid", "in":"header", "description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)", "schema":{ "type":"string" } }, { "name":"nonce", "in":"header", "description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ", "required":true, "schema":{ "type":"string" } }, { "name":"x-lang", "in":"header", "description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ", "required":false, "schema":{ "type":"string", "enum":[ "pt-BR", "en-US" ] } }, { "name":"x-product-uuid", "in":"header", "description":"The product ID is a UUID (v4) used to identify the Z.ro \n product configuration.\n ", "required":false, "schema":{ "type":"string" } }, { "name":"x-product-target-user-uuid", "in":"header", "description":"The product target user ID is a UUID (v4) used to identify \n what user account this request must be executed.\n Require: x-product-uuid. \n ", "required":false, "schema":{ "type":"string" } }, { "name":"id", "required":true, "in":"path", "description":"Three DS ID.", "schema":{ "example":"0197b169-da6b-7ba2-b053-ce413ae39afd", "type":"string" } } ], "responses":{ "200":{ "description":"Transaction details retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/V1GetThreeDsByIdRestResponse" } } } }, "400":{ "description":"If any required params are missing or has invalid format or type." }, "401":{ "description":"User authentication failed." }, "422":{ "description":"If any required params are missing or has invalid format or type." } }, "security":[ { "bearer":[ ] } ], "summary":"Get 3DS authentication by ID", "tags":[ "Payments | 3DS Authentication" ] } }, "/v1/payout/{id}":{ "get":{ "description":"Tag: api-payments-gateway-get-payout-by-id
\n Description: Retrieve payout details by its unique ID.", "operationId":"V1GetPayoutByIdRestController_execute_v1", "parameters":[ { "name":"x-wallet-uuid", "in":"header", "description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)", "schema":{ "type":"string" } }, { "name":"nonce", "in":"header", "description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ", "required":true, "schema":{ "type":"string" } }, { "name":"x-lang", "in":"header", "description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ", "required":false, "schema":{ "type":"string", "enum":[ "pt-BR", "en-US" ] } }, { "name":"x-product-uuid", "in":"header", "description":"The product ID is a UUID (v4) used to identify the Z.ro \n product configuration.\n ", "required":false, "schema":{ "type":"string" } }, { "name":"x-product-target-user-uuid", "in":"header", "description":"The product target user ID is a UUID (v4) used to identify \n what user account this request must be executed.\n Require: x-product-uuid. \n ", "required":false, "schema":{ "type":"string" } }, { "name":"type", "required":true, "in":"query", "description":"Payment method type", "schema":{ "enum":[ "BANK_TRANSFER" ], "type":"string" } }, { "name":"id", "required":true, "in":"path", "description":"Payout ID", "schema":{ "example":"105c1f71-8663-7e2d-aa28-c7872562bdaf", "type":"string" } } ], "responses":{ "200":{ "description":"Payout details retrieved successfully.", "content":{ "application/json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/V1GetBankTransferPaymentByIdResponse" } ] }, "examples":{ "bankTransfer":{ "summary":"Bank Transfer details" } } } } }, "400":{ "description":"If any required params are missing or has invalid format or type." }, "401":{ "description":"User authentication failed." }, "422":{ "description":"If any required params are missing or has invalid format or type." } }, "security":[ { "bearer":[ ] } ], "summary":"Get Payout by ID", "tags":[ "Payout" ] } }, "/v1/payout":{ "post":{ "description":"Tag: api-payments-gateway-post-payout
\n Description: Create a new payout.
", "operationId":"V1CreatePayoutRestController_execute_v1", "parameters":[ { "name":"x-include-replay-protection-schema", "in":"header", "description":"The replay-protection-schema allows the user to choose between 3 options:
\n ", "schema":{ "type":"string" } }, { "name":"x-wallet-uuid", "in":"header", "description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)", "schema":{ "type":"string" } }, { "name":"x-transaction-uuid", "in":"header", "description":"The transaction ID is a UUID (v7) used to uniquely identify the object that will be created. All objects must have an identifier.", "required":true, "schema":{ "type":"string" } }, { "name":"nonce", "in":"header", "description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ", "required":true, "schema":{ "type":"string" } }, { "name":"x-lang", "in":"header", "description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ", "required":false, "schema":{ "type":"string", "enum":[ "pt-BR", "en-US" ] } }, { "name":"x-product-uuid", "in":"header", "description":"The product ID is a UUID (v4) used to identify the Z.ro \n product configuration.\n ", "required":false, "schema":{ "type":"string" } }, { "name":"x-product-target-user-uuid", "in":"header", "description":"The product target user ID is a UUID (v4) used to identify \n what user account this request must be executed.\n Require: x-product-uuid. \n ", "required":false, "schema":{ "type":"string" } } ], "requestBody":{ "required":true, "description":"Payout creation request body. Choose one of the available payout method bodies.", "content":{ "application/json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/V1CreatePayoutBody" }, { "$ref":"#/components/schemas/V1CreateBankTransferPaymentBody" } ], "discriminator":{ "propertyName":"payment_method", "mapping":{ "PAYOUT":"#/components/schemas/V1CreateBankTransferPaymentBody" } } } } } }, "responses":{ "200":{ "description":"Payout created successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/V1CreatePayoutResponse" } } } }, "400":{ "description":"If any required params are missing or has invalid format or type." }, "401":{ "description":"User authentication failed." }, "422":{ "description":"If any required params are missing or has invalid format or type." } }, "security":[ { "bearer":[ ] } ], "summary":"Create Payout", "tags":[ "Payout" ] }, "get":{ "description":"Tag: api-payments-gateway-get-payout-all
\n Description: Retrieve all payouts for the authenticated user by payout type, with an optional country filter and pagination.", "operationId":"V1GetAllPayoutsRestController_execute_v1", "parameters":[ { "name":"x-wallet-uuid", "in":"header", "description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)", "schema":{ "type":"string" } }, { "name":"nonce", "in":"header", "description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ", "required":true, "schema":{ "type":"string" } }, { "name":"x-lang", "in":"header", "description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ", "required":false, "schema":{ "type":"string", "enum":[ "pt-BR", "en-US" ] } }, { "name":"x-product-uuid", "in":"header", "description":"The product ID is a UUID (v4) used to identify the Z.ro \n product configuration.\n ", "required":false, "schema":{ "type":"string" } }, { "name":"x-product-target-user-uuid", "in":"header", "description":"The product target user ID is a UUID (v4) used to identify \n what user account this request must be executed.\n Require: x-product-uuid. \n ", "required":false, "schema":{ "type":"string" } }, { "name":"page", "required":false, "in":"query", "description":"Page number, starting from 1. Default is 1.", "schema":{ "type":"number" } }, { "name":"sort", "required":false, "in":"query", "description":"Field to sort the results by.", "schema":{ "type":"string" } }, { "name":"country", "required":true, "in":"query", "schema":{ "enum":[ "BRA", "ARG", "CHL", "PER" ], "type":"string" } }, { "name":"type", "required":true, "in":"query", "schema":{ "enum":[ "CREDIT_CARD", "DEBIT_CARD", "CASH", "BANK_TRANSFER" ], "type":"string" } } ], "responses":{ "200":{ "description":"Payouts retrieved successfully.", "content":{ "application/json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/V1GetAllBankTransferPaymentsResponse" } ] } } } }, "400":{ "description":"If any required params are missing or has invalid format or type." }, "401":{ "description":"User authentication failed." }, "422":{ "description":"If any required params are missing or has invalid format or type." } }, "security":[ { "bearer":[ ] } ], "summary":"Get all payout", "tags":[ "Payout" ] } }, "/v1/payout/banks/{country}":{ "get":{ "description":"Tag: api-payments-gateway-get-bank-all-by-country
\n Description: Retrieve all banks for the authenticated user by country.", "operationId":"V1GetAllBankFinancialInstitutionsByCountryRestController_execute_v1", "parameters":[ { "name":"x-wallet-uuid", "in":"header", "description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)", "schema":{ "type":"string" } }, { "name":"nonce", "in":"header", "description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ", "required":true, "schema":{ "type":"string" } }, { "name":"x-lang", "in":"header", "description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ", "required":false, "schema":{ "type":"string", "enum":[ "pt-BR", "en-US" ] } }, { "name":"x-product-uuid", "in":"header", "description":"The product ID is a UUID (v4) used to identify the Z.ro \n product configuration.\n ", "required":false, "schema":{ "type":"string" } }, { "name":"x-product-target-user-uuid", "in":"header", "description":"The product target user ID is a UUID (v4) used to identify \n what user account this request must be executed.\n Require: x-product-uuid. \n ", "required":false, "schema":{ "type":"string" } }, { "name":"country", "required":true, "in":"path", "description":"Country code to filter banks.", "schema":{ "example":"ARG", "enum":[ "BRA", "ARG", "CHL", "PER" ], "type":"string" } }, { "name":"page", "required":false, "in":"query", "description":"Page number.", "schema":{ "default":1, "type":"number" } }, { "name":"size", "required":false, "in":"query", "description":"Page size. Max size is 100.", "schema":{ "maximum":100, "default":20, "type":"number" } }, { "name":"sort", "required":false, "in":"query", "description":"Page sort attribute.", "schema":{ "example":"created_at", "enum":[ "created_at" ], "type":"string" } }, { "name":"order", "required":false, "in":"query", "description":"Page order.", "schema":{ "default":"asc", "enum":[ "asc", "desc" ], "type":"string" } } ], "responses":{ "200":{ "description":"Banks retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/V1GetAllBankFinancialInstitutionsByCountryResponse" } } } }, "400":{ "description":"If any required params are missing or has invalid format or type." }, "401":{ "description":"User authentication failed." }, "422":{ "description":"If any required params are missing or has invalid format or type." } }, "security":[ { "bearer":[ ] } ], "summary":"Get all banks by country", "tags":[ "Payout | Bank" ] } } }, "info":{ "title":"Z.ro Bank Payments Gateway API", "description":"Z.ro Bank Payments Gateway API", "version":"1.66.4", "contact":{ "name":"Z.ro Bank", "url":"https://www.zrobank.com.br", "email":"tecnologia@zrobank.com.br" }, "license":{ "name":"All rights reserved", "url":"https://www.zrobank.com.br" } }, "tags":[ ], "servers":[ ], "components":{ "securitySchemes":{ "bearer":{ "scheme":"bearer", "bearerFormat":"JWT", "type":"http" } }, "schemas":{ "V1AuthenticateRestRequest":{ "type":"object", "properties":{ "api_id":{ "type":"string", "description":"User defined apiId.", "example":"2af31bf2-e676-4e81-8dde-dfd671124f00" }, "api_key":{ "type":"string", "description":"User defined apiKey.", "example":"superpassword" } }, "required":[ "api_id", "api_key" ] }, "AuthenticateRestResponse":{ "type":"object", "properties":{ "access_token":{ "type":"string", "description":"JWT access token. Token used to access all protected endpoints." } }, "required":[ "access_token" ] }, "RefreshTokenRestResponse":{ "type":"object", "properties":{ "access_token":{ "type":"string", "description":"JWT access token. Token used to access all protected endpoints." } }, "required":[ "access_token" ] }, "V1GetAcquiringSettledTransactionResponse":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Settled Transaction ID.", "example":"0197b169-da6b-7ba2-b053-ce413ae39afd" }, "amount":{ "type":"number", "description":"Settled Transaction Amount.", "example":1234 }, "installment_number":{ "type":"number", "description":"Installment Number.", "example":1 }, "created_at":{ "format":"date-time", "type":"string", "description":"Transaction Creation Date.", "example":"2025-10-22T15:30:01.702Z" } }, "required":[ "id", "amount", "created_at" ] }, "V1GetAcquiringPaymentByIdResponse":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Payment ID.", "example":"0197b169-da6b-7ba2-b053-ce413ae39afd" }, "operation_id":{ "type":"string", "description":"Operation ID associated with the transaction.", "example":"456e7890-e12b-34d5-a678-426614174001" }, "country":{ "type":"string", "description":"Country Of Transaction.", "example":"BR" }, "sales_channel":{ "type":"string", "description":"Payment Sales Channel.", "enum":[ "POS", "PDV", "MPOS", "PAYLINK", "INTEGRATION", "TAP_ON_PHONE", "VIRTUAL_TERMINAL" ], "example":"INTEGRATION" }, "payment_method":{ "type":"string", "description":"Payment Method.", "enum":[ "DEBIT_CARD", "CREDIT_CARD" ], "example":"CREDIT_CARD" }, "amount":{ "type":"number", "description":"Payment Value.", "example":100 }, "currency_tag":{ "type":"string", "description":"Payment Currency Tag.", "enum":[ "PEN", "CLP", "ARS", "USD", "BRL" ], "example":"BRL" }, "status":{ "type":"string", "description":"Transaction Status.", "enum":[ "PENDING", "WAITING", "WAITING_THREE_DS", "AUTHORIZED", "EXPIRED", "DECLINED", "REVERTED", "CANCELLATION_IN_PROGRESS", "CANCELLED", "SETTLED", "REFUNDED", "FAILED" ], "example":"AUTHORIZED" }, "third_part_name":{ "type":"string", "description":"Third Part Full Name.", "example":"John Doe" }, "third_part_email":{ "type":"string", "description":"Third Part Email Address.", "example":"john.doe@example.com" }, "third_part_phone_number":{ "type":"string", "description":"Third Part Phone Number.", "example":"+5511999998888" }, "third_part_document_type":{ "type":"string", "description":"Third Part Document Type.", "enum":[ "DNI", "CE", "PAS", "PP", "RUT", "RUC", "CUIL", "CUIT", "CPF", "CNPJ" ], "example":"CPF" }, "third_part_document":{ "type":"string", "description":"Third Part Document Number.", "example":"12345678901" }, "third_part_address_city":{ "type":"string", "description":"Third Part Address City.", "example":"São Paulo" }, "third_part_address_country":{ "type":"string", "description":"Third Part Address Country.", "example":"BR" }, "third_part_address_federative_unit":{ "type":"string", "description":"Third Part Address Federative Unit.", "example":"SP" }, "third_part_address_number":{ "type":"string", "description":"Third Part Address Number.", "example":"123" }, "third_part_address_street":{ "type":"string", "description":"Third Part Address Street.", "example":"Avenida Paulista" }, "third_part_address_zip_code":{ "type":"string", "description":"Third Part Address Zip Code.", "example":"01311000" }, "third_part_address_complement":{ "type":"string", "description":"Third Part Address Complement.", "example":"Apto 101" }, "third_part_address_neighborhood":{ "type":"string", "description":"Third Part Address Neighborhood.", "example":"Bela Vista" }, "card_last_four_digits":{ "type":"string", "description":"Last four digits of the card used.", "example":"1234" }, "installments":{ "type":"number", "description":"Number of installments for the transaction.", "example":1 }, "authorized_date":{ "format":"date-time", "type":"string", "description":"Transaction Confirmation Date.", "example":"2023-01-01T12:00:00.000Z" }, "declined_date":{ "format":"date-time", "type":"string", "description":"Transaction Declined Date.", "example":"2023-01-01T12:00:00.000Z" }, "cancelled_date":{ "format":"date-time", "type":"string", "description":"Transaction Cancelled Date.", "example":"2023-01-01T12:00:00.000Z" }, "settlement_date":{ "format":"date-time", "type":"string", "description":"Transaction Settled Date.", "example":"2023-01-01T12:00:00.000Z" }, "cancelled_max_date":{ "format":"date-time", "type":"string", "description":"Transaction Cancelled Max Date.", "example":"2023-01-01T12:00:00.000Z" }, "expected_settlement_date":{ "format":"date-time", "type":"string", "description":"Expected External Settlement Date.", "example":"2023-01-02T12:00:00.000Z" }, "settled_acquiring_transactions":{ "description":"Settled Acquiring Transactions", "type":"array", "items":{ "$ref":"#/components/schemas/V1GetAcquiringSettledTransactionResponse" } }, "refunded_date":{ "format":"date-time", "type":"string", "description":"Transaction Refunded Date.", "example":"2023-01-02T12:00:00.000Z" }, "payment_url":{ "type":"string", "description":"Url to provide to customer to continue the payment.", "example":"https://example.com/deposit/0197b169-da6b-7ba2-b053-ce413ae39afd" }, "redirect_url":{ "type":"string", "description":"Redirect URL for payment success and error.", "example":"https://example.com/my-home-page" }, "expiration_time_minutes":{ "type":"number", "description":"Expected time in minutes for transaction expiration.", "example":120 }, "language":{ "type":"string", "description":"Language code for the transaction, e.g., \"en\", \"pt\".", "example":"pt" }, "expiration_date":{ "format":"date-time", "type":"string", "description":"Transaction Expiration Date.", "example":"2023-01-02T12:00:00.000Z" }, "created_at":{ "format":"date-time", "type":"string", "description":"Transaction creation date", "example":"2023-01-01T10:00:00.000Z" }, "updated_at":{ "format":"date-time", "type":"string", "description":"Transaction last update date", "example":"2023-01-01T11:00:00.000Z" } }, "required":[ "id", "country", "sales_channel", "payment_method", "amount", "currency_tag", "status", "third_part_name", "third_part_email", "third_part_phone_number", "third_part_document_type", "third_part_document", "third_part_address_city", "third_part_address_country", "third_part_address_federative_unit", "third_part_address_number", "third_part_address_street", "third_part_address_zip_code", "card_last_four_digits", "installments", "settled_acquiring_transactions", "created_at", "updated_at" ] }, "V1GetCashDepositByIdResponse":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Payment ID.", "example":"0197b169-da6b-7ba2-b053-ce413ae39afd" }, "operation_id":{ "type":"string", "description":"Operation ID associated with the transaction.", "example":"456e7890-e12b-34d5-a678-426614174001" }, "country":{ "type":"object", "description":"Country of the transaction.", "example":"ARG" }, "status":{ "type":"object", "description":"Status of the transaction.", "example":"PENDING" }, "amount":{ "type":"number", "description":"Amount of the transaction.", "example":100 }, "currency_tag":{ "type":"object", "description":"Currency of the transaction.", "example":"PEN" }, "expiration_time_minutes":{ "type":"number", "description":"Expiration time in minutes.", "example":10 }, "payment_url":{ "type":"string", "description":"Url to provide to customer to continue the payment.", "example":"https://example.com/deposit/0197b169-da6b-7ba2-b053-ce413ae39afd" }, "third_part_name":{ "type":"string", "description":"Third part name.", "example":"John Doe" }, "third_part_last_name":{ "type":"string", "description":"Third part last name.", "example":"Doe" }, "third_part_email":{ "type":"string", "description":"Third part email.", "example":"john.doe@example.com" }, "third_part_phone":{ "type":"string", "description":"Third part phone.", "example":"+5511999998888" }, "third_part_document":{ "type":"string", "description":"Third part document.", "example":"12345678901" }, "third_part_document_type":{ "type":"object", "description":"Third part document type.", "example":"DNI" }, "third_part_address_zip_code":{ "type":"string", "description":"Third part address zip code.", "example":"01311000" }, "third_part_address_street":{ "type":"string", "description":"Third part address street.", "example":"Avenida Paulista" }, "third_part_address_number":{ "type":"string", "description":"Third part address number.", "example":123 }, "third_part_address_city":{ "type":"string", "description":"Third part address city.", "example":"São Paulo" }, "third_part_address_state":{ "type":"string", "description":"Third part address state.", "example":"SP" }, "third_part_address_country":{ "type":"string", "description":"Third part address country.", "example":"BR" }, "third_part_address_complement":{ "type":"string", "description":"Third part address complement.", "example":"Apto 101" }, "redirect_url":{ "type":"string", "description":"Redirect URL for payment success and error.", "example":"https://example.com/payment/my-main-page" }, "expiration_date":{ "format":"date-time", "type":"string", "description":"Expiration date.", "example":"2023-01-01T12:00:00.000Z" }, "authorized_date":{ "format":"date-time", "type":"string", "description":"Authorized date.", "example":"2023-01-01T12:00:00.000Z" }, "refunded_date":{ "format":"date-time", "type":"string", "description":"Refunded date.", "example":"2023-01-01T12:00:00.000Z" }, "settlement_date":{ "format":"date-time", "type":"string", "description":"Settlement date.", "example":"2023-01-01T12:00:00.000Z" }, "failed_date":{ "format":"date-time", "type":"string", "description":"Failed date.", "example":"2023-01-01T12:00:00.000Z" }, "created_at":{ "format":"date-time", "type":"string", "description":"Created at.", "example":"2023-01-01T12:00:00.000Z" }, "updated_at":{ "format":"date-time", "type":"string", "description":"Updated at.", "example":"2023-01-01T12:00:00.000Z" } }, "required":[ "id", "country", "status", "amount", "currency_tag", "third_part_name", "third_part_last_name", "third_part_email", "third_part_phone", "third_part_document", "third_part_document_type", "third_part_address_zip_code", "third_part_address_street", "third_part_address_number", "third_part_address_city", "third_part_address_state", "third_part_address_country", "third_part_address_complement", "redirect_url", "created_at", "updated_at" ] }, "V1GetBankTransferDepositByIdResponse":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Payment ID.", "example":"0197b169-da6b-7ba2-b053-ce413ae39afd" }, "operation_id":{ "type":"string", "description":"Operation ID associated with the transaction.", "example":"456e7890-e12b-34d5-a678-426614174001" }, "country":{ "type":"object", "description":"Country of the transaction.", "example":"ARG" }, "url":{ "type":"string", "description":"URL for completing the bank transfer.", "example":"https://bank.example.com/transfer/0197b169-da6b-7ba2-b053-ce413ae39afd" }, "status":{ "type":"object", "description":"Status of the transaction.", "example":"PENDING" }, "amount":{ "type":"number", "description":"Amount of the transaction.", "example":100 }, "currency_tag":{ "type":"object", "description":"Currency of the transaction.", "example":"PEN" }, "expiration_time_minutes":{ "type":"number", "description":"Expiration time in minutes.", "example":10 }, "payment_url":{ "type":"string", "description":"Url to provide to customer to continue the payment.", "example":"https://example.com/deposit/0197b169-da6b-7ba2-b053-ce413ae39afd" }, "third_part_name":{ "type":"string", "description":"Third part name.", "example":"John Doe" }, "third_part_last_name":{ "type":"string", "description":"Third part last name.", "example":"Doe" }, "third_part_email":{ "type":"string", "description":"Third part email.", "example":"john.doe@example.com" }, "third_part_phone":{ "type":"string", "description":"Third part phone.", "example":"+5511999998888" }, "third_part_document":{ "type":"string", "description":"Third part document.", "example":"12345678901" }, "third_part_document_type":{ "type":"object", "description":"Third part document type.", "example":"DNI" }, "third_part_address_zip_code":{ "type":"string", "description":"Third part address zip code.", "example":"01311000" }, "third_part_address_street":{ "type":"string", "description":"Third part address street.", "example":"Avenida Paulista" }, "third_part_address_number":{ "type":"string", "description":"Third part address number.", "example":"123" }, "third_part_address_city":{ "type":"string", "description":"Third part address city.", "example":"São Paulo" }, "third_part_address_state":{ "type":"string", "description":"Third part address state.", "example":"SP" }, "third_part_address_country":{ "type":"string", "description":"Third part address country.", "example":"BR" }, "third_part_address_complement":{ "type":"string", "description":"Third part address complement.", "example":"Apto 101" }, "redirect_url":{ "type":"string", "description":"Redirect URL for payment success and error.", "example":"https://example.com/payment/my-main-page" }, "expiration_date":{ "format":"date-time", "type":"string", "description":"Expiration date.", "example":"2023-01-01T12:00:00.000Z" }, "authorized_date":{ "format":"date-time", "type":"string", "description":"Authorized date.", "example":"2023-01-01T12:00:00.000Z" }, "refunded_date":{ "format":"date-time", "type":"string", "description":"Refunded date.", "example":"2023-01-01T12:00:00.000Z" }, "settlement_date":{ "format":"date-time", "type":"string", "description":"Settlement date.", "example":"2023-01-01T12:00:00.000Z" }, "created_at":{ "format":"date-time", "type":"string", "description":"Created at.", "example":"2023-01-01T12:00:00.000Z" }, "updated_at":{ "format":"date-time", "type":"string", "description":"Updated at.", "example":"2023-01-01T12:00:00.000Z" } }, "required":[ "id", "country", "status", "amount", "currency_tag", "third_part_name", "third_part_last_name", "third_part_email", "third_part_phone", "third_part_document", "third_part_document_type", "third_part_address_zip_code", "third_part_address_street", "third_part_address_number", "third_part_address_city", "third_part_address_state", "third_part_address_country", "third_part_address_complement", "redirect_url", "created_at", "updated_at" ] }, "V1GetAllAcquiringPaymentsResponseItem":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Payment ID.", "example":"0197b169-da6b-7ba2-b053-ce413ae39afd" }, "user_id":{ "type":"string", "description":"User ID of the merchant who performed the transaction.", "example":"123e4567-e89b-12d3-a456-426614174000" }, "operation_id":{ "type":"string", "description":"Operation ID associated with the transaction.", "example":"456e7890-e12b-34d5-a678-426614174001" }, "wallet_id":{ "type":"string", "description":"Wallet ID associated with the transaction.", "example":"789e0123-e45b-67d8-a901-426614174002" }, "country":{ "type":"string", "description":"Country Of Transaction.", "example":"BR" }, "sales_channel":{ "type":"string", "description":"Payment Sales Channel.", "enum":[ "POS", "PDV", "MPOS", "PAYLINK", "INTEGRATION", "TAP_ON_PHONE", "VIRTUAL_TERMINAL" ], "example":"INTEGRATION" }, "payment_method":{ "type":"string", "description":"Payment Method.", "enum":[ "DEBIT_CARD", "CREDIT_CARD" ], "example":"CREDIT_CARD" }, "amount":{ "type":"number", "description":"Payment Value in cents.", "example":100 }, "currency_tag":{ "type":"string", "description":"Payment Currency Tag.", "enum":[ "PEN", "CLP", "ARS", "USD", "BRL" ], "example":"BRL" }, "status":{ "type":"string", "description":"Transaction Status.", "enum":[ "PENDING", "WAITING", "WAITING_THREE_DS", "AUTHORIZED", "EXPIRED", "DECLINED", "REVERTED", "CANCELLATION_IN_PROGRESS", "CANCELLED", "SETTLED", "REFUNDED", "FAILED" ], "example":"AUTHORIZED" }, "third_part_name":{ "type":"string", "description":"Third Part Full Name.", "example":"John Doe" }, "third_part_email":{ "type":"string", "description":"Third Part Email Address.", "example":"john.doe@example.com" }, "third_part_phone_number":{ "type":"string", "description":"Third Part Phone Number.", "example":"+5511999998888" }, "third_part_document_type":{ "type":"string", "description":"Third Part Document Type.", "enum":[ "DNI", "CE", "PAS", "PP", "RUT", "RUC", "CUIL", "CUIT", "CPF", "CNPJ" ], "example":"CPF" }, "third_part_document":{ "type":"string", "description":"Third Part Document Number.", "example":"12345678901" }, "third_part_address_city":{ "type":"string", "description":"Third Part Address City.", "example":"São Paulo" }, "third_part_address_country":{ "type":"string", "description":"Third Part Address Country.", "example":"BR" }, "third_part_address_state":{ "type":"string", "description":"Third Part Address Federative Unit.", "example":"SP" }, "third_part_address_number":{ "type":"string", "description":"Third Part Address Number.", "example":"123" }, "third_part_address_street":{ "type":"string", "description":"Third Part Address Street.", "example":"Avenida Paulista" }, "third_part_address_zip_code":{ "type":"string", "description":"Third Part Address Zip Code.", "example":"01311000" }, "third_part_address_complement":{ "type":"string", "description":"Third Part Address Complement.", "example":"Apto 101" }, "card_last_four_digits":{ "type":"string", "description":"Last four digits of the card used.", "example":"1234" }, "installments":{ "type":"number", "description":"Number of installments for the transaction.", "example":1 }, "authorized_date":{ "format":"date-time", "type":"string", "description":"Transaction Confirmation Date.", "example":"2023-01-01T12:00:00.000Z" }, "declined_date":{ "format":"date-time", "type":"string", "description":"Transaction Declined Date.", "example":"2023-01-01T12:00:00.000Z" }, "cancelled_date":{ "format":"date-time", "type":"string", "description":"Transaction Cancelled Date.", "example":"2023-01-01T12:00:00.000Z" }, "settlement_date":{ "format":"date-time", "type":"string", "description":"Transaction Settled Date.", "example":"2023-01-01T12:00:00.000Z" }, "cancelled_max_date":{ "format":"date-time", "type":"string", "description":"Transaction Cancelled Max Date.", "example":"2023-01-01T12:00:00.000Z" }, "expected_settlement_date":{ "format":"date-time", "type":"string", "description":"Expected External Settlement Date.", "example":"2023-01-02T12:00:00.000Z" }, "refunded_date":{ "format":"date-time", "type":"string", "description":"Transaction Refunded Date.", "example":"2023-01-02T12:00:00.000Z" }, "payment_url":{ "type":"string", "description":"Url to provide to customer to continue the payment.", "example":"https://example.com/deposit/0197b169-da6b-7ba2-b053-ce413ae39afd" }, "redirect_url":{ "type":"string", "description":"Redirect URL for payment success and error.", "example":"https://example.com/my-home-page" }, "expiration_time_minutes":{ "type":"number", "description":"Expected time in minutes for transaction expiration.", "example":120 }, "language":{ "type":"string", "description":"Language code for the transaction, e.g., \"en\", \"pt\".", "example":"pt" }, "expiration_date":{ "format":"date-time", "type":"string", "description":"Transaction Expiration Date.", "example":"2023-01-02T12:00:00.000Z" }, "created_at":{ "format":"date-time", "type":"string", "description":"Transaction creation date", "example":"2023-01-01T10:00:00.000Z" }, "updated_at":{ "format":"date-time", "type":"string", "description":"Transaction last update date", "example":"2023-01-01T11:00:00.000Z" } }, "required":[ "id", "user_id", "country", "sales_channel", "payment_method", "amount", "currency_tag", "status", "third_part_name", "third_part_email", "third_part_phone_number", "third_part_document_type", "third_part_document", "third_part_address_city", "third_part_address_country", "third_part_address_state", "third_part_address_number", "third_part_address_street", "third_part_address_zip_code", "card_last_four_digits", "installments", "created_at", "updated_at" ] }, "V1GetAllAcquiringPaymentsResponse":{ "type":"object", "properties":{ "page":{ "type":"number", "description":"Page number.", "example":1 }, "page_size":{ "type":"number", "description":"Page size.", "example":20 }, "page_total":{ "type":"number", "description":"Page total.", "example":20 }, "total":{ "type":"number", "description":"Total of elements.", "example":100 }, "data":{ "description":"List of acquiring payments.", "type":"array", "items":{ "$ref":"#/components/schemas/V1GetAllAcquiringPaymentsResponseItem" } } }, "required":[ "page", "page_size", "page_total", "total", "data" ] }, "V1GetAllCashDepositsResponseItem":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Payment ID.", "example":"0197b169-da6b-7ba2-b053-ce413ae39afd" }, "operation_id":{ "type":"string", "description":"Operation ID associated with the transaction.", "example":"456e7890-e12b-34d5-a678-426614174001" }, "country":{ "type":"object", "description":"Country of the transaction.", "example":"ARG" }, "status":{ "type":"object", "description":"Status of the transaction.", "example":"PENDING" }, "amount":{ "type":"number", "description":"Amount of the transaction in cents.", "example":100 }, "currency_tag":{ "type":"object", "description":"Currency of the transaction.", "example":"PEN" }, "expiration_time_minutes":{ "type":"number", "description":"Expiration time in minutes.", "example":10 }, "payment_url":{ "type":"string", "description":"Url to provide to customer to continue the payment.", "example":"https://example.com/deposit/0197b169-da6b-7ba2-b053-ce413ae39afd" }, "third_part_name":{ "type":"string", "description":"Third part name.", "example":"John Doe" }, "third_part_last_name":{ "type":"string", "description":"Third part last name.", "example":"Doe" }, "third_part_email":{ "type":"string", "description":"Third part email.", "example":"john.doe@example.com" }, "third_part_phone":{ "type":"string", "description":"Third part phone.", "example":"+5511999998888" }, "third_part_document":{ "type":"string", "description":"Third part document.", "example":"12345678901" }, "third_part_document_type":{ "type":"object", "description":"Third part document type.", "example":"DNI" }, "third_part_address_zip_code":{ "type":"string", "description":"Third part address zip code.", "example":"01311000" }, "third_part_address_street":{ "type":"string", "description":"Third part address street.", "example":"Avenida Paulista" }, "third_part_address_number":{ "type":"string", "description":"Third part address number.", "example":123 }, "third_part_address_city":{ "type":"string", "description":"Third part address city.", "example":"São Paulo" }, "third_part_address_state":{ "type":"string", "description":"Third part address state.", "example":"SP" }, "third_part_address_country":{ "type":"string", "description":"Third part address country.", "example":"BR" }, "third_part_address_complement":{ "type":"string", "description":"Third part address complement.", "example":"Apto 101" }, "redirect_url":{ "type":"string", "description":"Redirect URL for payment success and error.", "example":"https://example.com/payment/my-home-page" }, "expiration_date":{ "format":"date-time", "type":"string", "description":"Expiration date.", "example":"2023-01-01T12:00:00.000Z" }, "authorized_date":{ "format":"date-time", "type":"string", "description":"Authorized date.", "example":"2023-01-01T12:00:00.000Z" }, "refunded_date":{ "format":"date-time", "type":"string", "description":"Refunded date.", "example":"2023-01-01T12:00:00.000Z" }, "settlement_date":{ "format":"date-time", "type":"string", "description":"Settlement date.", "example":"2023-01-01T12:00:00.000Z" }, "failed_date":{ "format":"date-time", "type":"string", "description":"Failed date.", "example":"2023-01-01T12:00:00.000Z" }, "created_at":{ "format":"date-time", "type":"string", "description":"Created at.", "example":"2023-01-01T12:00:00.000Z" }, "updated_at":{ "format":"date-time", "type":"string", "description":"Updated at.", "example":"2023-01-01T12:00:00.000Z" } }, "required":[ "id", "country", "status", "amount", "currency_tag", "third_part_name", "third_part_last_name", "third_part_email", "third_part_phone", "third_part_document", "third_part_document_type", "third_part_address_zip_code", "third_part_address_street", "third_part_address_number", "third_part_address_city", "third_part_address_state", "third_part_address_country", "redirect_url", "created_at", "updated_at" ] }, "V1GetAllCashDepositsResponse":{ "type":"object", "properties":{ "page":{ "type":"number", "description":"Page number.", "example":1 }, "page_size":{ "type":"number", "description":"Page size.", "example":20 }, "page_total":{ "type":"number", "description":"Page total.", "example":20 }, "total":{ "type":"number", "description":"Total of elements.", "example":100 }, "data":{ "description":"List of cash payments.", "type":"array", "items":{ "$ref":"#/components/schemas/V1GetAllCashDepositsResponseItem" } } }, "required":[ "page", "page_size", "page_total", "total", "data" ] }, "V1GetAllBankTransferDepositResponseItem":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Deposit ID.", "example":"0197b169-da6b-7ba2-b053-ce413ae39afd" }, "user_id":{ "type":"string", "description":"User ID associated with the deposit.", "example":"123e4567-e89b-12d3-a456-426614174000" }, "wallet_id":{ "type":"string", "description":"Wallet ID associated with the deposit.", "example":"223e4567-e89b-12d3-a456-426614174000" }, "operation_id":{ "type":"string", "description":"Operation ID associated with the deposit.", "example":"456e7890-e12b-34d5-a678-426614174001" }, "country":{ "type":"object", "description":"Country of the deposit.", "example":"ARG" }, "status":{ "type":"object", "description":"Status of the deposit.", "example":"PENDING" }, "amount":{ "type":"number", "description":"Amount of the deposit.", "example":1000 }, "currency_tag":{ "type":"string", "description":"Currency tag of the deposit.", "example":"USD" }, "expiration_time_minutes":{ "type":"number", "description":"Expiration time in minutes.", "example":10 }, "payment_url":{ "type":"string", "description":"Url to provide to customer to continue the payment.", "example":"https://example.com/deposit/0197b169-da6b-7ba2-b053-ce413ae39afd" }, "language":{ "type":"object", "description":"Language preference for the deposit process.", "example":"en" }, "third_part_name":{ "type":"string", "description":"Third party's first name.", "example":"John" }, "third_part_last_name":{ "type":"string", "description":"Third party's last name.", "example":"Doe" }, "third_part_email":{ "type":"string", "description":"Third party's email address.", "example":"third.party@example.com" }, "third_part_phone":{ "type":"string", "description":"Third party's phone number.", "example":"+1234567890" }, "third_part_document":{ "type":"string", "description":"Third party's document number.", "example":"A12345678" }, "third_part_document_type":{ "type":"string", "description":"Third party's document type.", "example":"DNI" }, "third_part_address_zip_code":{ "type":"string", "description":"Third party's address zip code.", "example":"12345" }, "third_part_address_street":{ "type":"string", "description":"Third party's address street.", "example":"Main St" }, "third_part_address_number":{ "type":"string", "description":"Third party's address number.", "example":"100" }, "third_part_address_city":{ "type":"string", "description":"Third party's address city.", "example":"Metropolis" }, "third_part_address_state":{ "type":"string", "description":"Third party's address state.", "example":"StateName" }, "third_part_address_country":{ "type":"string", "description":"Third party's address country.", "example":"CountryName" }, "third_part_address_complement":{ "type":"string", "description":"Third party's address complement.", "example":"Apt 101" }, "expiration_date":{ "format":"date-time", "type":"string", "description":"Date when the expiration occurs.", "example":"2023-10-10T12:00:00Z" }, "authorized_date":{ "format":"date-time", "type":"string", "description":"Date when the deposit was authorized.", "example":"2023-10-01T12:00:00Z" }, "refunded_date":{ "format":"date-time", "type":"string", "description":"Date when the deposit refund.", "example":"2023-10-05T12:00:00Z" }, "settlement_date":{ "format":"date-time", "type":"string", "description":"Date when the settlement occurred.", "example":"2023-10-03T12:00:00Z" }, "scheduled_settlement_date":{ "format":"date-time", "type":"string", "description":"Date when the scheduled settlement will occur.", "example":"2023-09-30T12:00:00Z" }, "created_at":{ "format":"date-time", "type":"string", "description":"Creation date of the deposit record.", "example":"2023-09-30T12:00:00Z" }, "updated_at":{ "format":"date-time", "type":"string", "description":"Last update date of the deposit record.", "example":"2023-10-01T15:00:00Z" }, "redirect_url":{ "type":"string", "description":"Redirect URL for payment success and error.", "example":"https://example.com/my-home-page" } }, "required":[ "id", "user_id", "country", "status", "amount", "currency_tag", "expiration_time_minutes", "language", "third_part_name", "third_part_last_name", "third_part_phone", "third_part_document", "third_part_document_type", "third_part_address_zip_code", "third_part_address_street", "third_part_address_number", "third_part_address_city", "third_part_address_state", "third_part_address_country", "expiration_date", "authorized_date", "refunded_date", "settlement_date", "scheduled_settlement_date", "created_at", "updated_at", "redirect_url" ] }, "V1GetAllBankTransferDepositsResponse":{ "type":"object", "properties":{ "page":{ "type":"number", "description":"Page number.", "example":1 }, "page_size":{ "type":"number", "description":"Page size.", "example":20 }, "page_total":{ "type":"number", "description":"Page total.", "example":20 }, "total":{ "type":"number", "description":"Total of elements.", "example":100 }, "data":{ "description":"List of bank transfer deposits.", "type":"array", "items":{ "$ref":"#/components/schemas/V1GetAllBankTransferDepositResponseItem" } } }, "required":[ "page", "page_size", "page_total", "total", "data" ] }, "CardRequest":{ "type":"object", "properties":{ "card_number":{ "type":"string", "description":"Card number.", "example":"1234567890123456" }, "card_cvv":{ "type":"string", "description":"Card CVV.", "example":"123" }, "card_name":{ "type":"string", "description":"Card Holder Name.", "example":"John Doe" }, "card_expiry_date":{ "type":"string", "description":"Card Expiry Date in MM-YYYY format.", "example":"04-2030" } }, "required":[ "card_number", "card_cvv", "card_name", "card_expiry_date" ] }, "V1CreatePayinBody":{ "type":"object", "properties":{ "country":{ "type":"string", "description":"Country ISO 3166-1-alpha-3 code for the payment.", "enum":[ "BRA", "ARG", "CHL", "PER" ], "example":"BRA" }, "payment_method":{ "type":"string", "description":"Payment method used in the transaction.", "enum":[ "CREDIT_CARD", "DEBIT_CARD", "CASH", "BANK_TRANSFER" ], "example":"CREDIT_CARD" }, "amount_total":{ "type":"number", "description":"Payment amount in cents. Must be at least 100 cents.", "example":10000 }, "currency_tag":{ "type":"string", "description":"Payment currency ISO 4217 code.", "enum":[ "PEN", "CLP", "ARS", "USD", "BRL" ], "example":"BRL" }, "third_part_name":{ "type":"string", "description":"Third Part first name.", "example":"John" }, "third_part_last_name":{ "type":"string", "description":"Third Part last name.", "example":"Doe" }, "third_part_email":{ "type":"string", "description":"Third Part email address.", "example":"john.doe@zrobank.com" }, "third_part_phone":{ "type":"string", "description":"Third Part phone number.", "example":"+5511999999999" }, "third_part_document":{ "type":"string", "description":"Third Part document.", "example":"12345678901" }, "third_part_document_type":{ "type":"string", "description":"Third Part document type.", "enum":[ "DNI", "CE", "PAS", "PP", "RUT", "RUC", "CUIL", "CUIT", "CPF", "CNPJ" ], "example":"CE" }, "third_part_address_zip_code":{ "type":"string", "description":"User Address Zip Code.", "example":"0975858" }, "third_part_address_street":{ "type":"string", "description":"User Address Street.", "example":"Alameda Santos" }, "third_part_address_number":{ "type":"string", "description":"User Address number.", "example":"10" }, "third_part_address_city":{ "type":"string", "description":"User Address City.", "example":"São Paulo" }, "third_part_address_state":{ "type":"string", "description":"User Address State.", "example":"SP" }, "third_part_address_country":{ "type":"string", "description":"User Address Country.", "example":"Brazil" }, "third_part_address_complement":{ "type":"string", "description":"User Address Complement.", "example":"flat 1201" }, "third_part_address_neighborhood":{ "type":"string", "description":"User Address Neighborhood (for acquiring payments).", "example":"Downtown" }, "payment_card":{ "description":"Payment Card details (required for acquiring payments).", "allOf":[ { "$ref":"#/components/schemas/CardRequest" } ] }, "installments":{ "type":"number", "description":"Number Of Installments. Allowed values: 1 to 12. Only for CREDIT payment method.", "example":1 }, "language":{ "type":"string", "description":"Language ISO 639-1 code for the payment.", "example":"en" }, "expiration_time_minutes":{ "type":"number", "description":"Expiration time in minutes for the payment.", "example":60 } }, "required":[ "country", "payment_method", "amount_total", "currency_tag", "third_part_name", "third_part_last_name", "third_part_email", "third_part_phone", "third_part_document", "third_part_document_type", "third_part_address_zip_code", "third_part_address_street", "third_part_address_number", "third_part_address_city", "third_part_address_state", "third_part_address_country", "language" ] }, "V1CreateAcquiringCreditPaymentBody":{ "type":"object", "properties":{ "country":{ "type":"string", "description":"Country ISO 3166-1-alpha-3 code for the payment.", "enum":[ "BRA", "CHL", "PER", "ARG" ], "example":"BRA" }, "payment_method":{ "type":"string", "description":"Payment method used in the transaction.", "enum":[ "CREDIT_CARD" ], "example":"CREDIT_CARD" }, "amount_total":{ "type":"number", "description":"Payment amount in cents. Min value is 1000 cents.", "example":10000 }, "currency_tag":{ "type":"string", "description":"Payment currency ISO 4217 code ", "example":"BRL", "enum":[ "PEN", "CLP", "ARS", "USD", "BRL" ] }, "third_part_name":{ "type":"string", "description":"Third Part first name.", "example":"John" }, "third_part_last_name":{ "type":"string", "description":"Third Part last name.", "example":"Doe" }, "third_part_email":{ "type":"string", "description":"Third Part email address.", "example":"john.doe@zrobank.com" }, "third_part_phone":{ "type":"string", "description":"Third Part phone number.", "example":"+5511999999999" }, "third_part_document":{ "type":"string", "description":"Third Part document.", "example":"12345678901" }, "third_part_document_type":{ "type":"string", "description":"Third Part document type.", "enum":[ "DNI", "CE", "PAS", "PP", "RUT", "RUC", "CUIL", "CUIT", "CPF", "CNPJ" ], "example":"CPF" }, "installments":{ "type":"number", "description":"Number Of Installments. Allowed values: 1 to 12.", "example":1 }, "payment_card":{ "description":"Payment Card details. Required when is_redirect is false (direct flow).", "allOf":[ { "$ref":"#/components/schemas/CardRequest" } ] }, "third_part_address_city":{ "type":"string", "description":"User Address City.", "example":"São Paulo" }, "third_part_address_country":{ "type":"string", "description":"User Address Country.", "example":"Brazil" }, "third_part_address_number":{ "type":"string", "description":"User Address number.", "example":"10" }, "third_part_address_state":{ "type":"string", "description":"User Address state.", "example":"SP" }, "third_part_address_street":{ "type":"string", "description":"User Address Street.", "example":"Alameda Santos" }, "third_part_address_zip_code":{ "type":"string", "description":"User Address Zip Code.", "example":"0975858" }, "third_part_address_complement":{ "type":"string", "description":"User Address Complement.", "example":"flat 1201" }, "third_part_address_neighborhood":{ "type":"string", "description":"User Address Neighborhood.", "example":"Downtown" }, "is_redirect":{ "type":"boolean", "description":"Whether to use redirect flow for payment processing. Default is true. If your company do not have a PCI certificate, you MUST send this field with \"true\"", "example":true }, "redirect_url":{ "type":"string", "description":"URL to redirect after payment completion. Required when is_redirect is true or undefined.", "example":"https://example.com/payment-success" }, "expiration_time_minutes":{ "type":"number", "description":"Payment expiration time in minutes. Required when is_redirect is true or undefined.", "example":30 }, "language":{ "type":"string", "description":"Language for the payment interface. Required when is_redirect is true or undefined.", "example":"pt-BR" } }, "required":[ "country", "payment_method", "amount_total", "currency_tag", "third_part_name", "third_part_last_name", "third_part_email", "third_part_phone", "third_part_document", "third_part_document_type", "installments", "third_part_address_city", "third_part_address_country", "third_part_address_number", "third_part_address_state", "third_part_address_street", "third_part_address_zip_code", "third_part_address_complement" ] }, "V1CreateAcquiringDebitPaymentBody":{ "type":"object", "properties":{ "country":{ "type":"string", "description":"Country ISO 3166-1-alpha-3 code for the payment.", "enum":[ "BRA", "CHL", "PER", "ARG" ], "example":"BRA" }, "payment_method":{ "type":"string", "description":"Payment method used in the transaction.", "enum":[ "DEBIT_CARD" ], "example":"DEBIT_CARD" }, "amount_total":{ "type":"number", "description":"Payment amount in cents. Min value is 1000 cents.", "example":10000 }, "currency_tag":{ "type":"string", "description":"Payment currency ISO 4217 code ", "example":"BRL", "enum":[ "PEN", "CLP", "ARS", "USD", "BRL" ] }, "payment_card":{ "description":"Payment Card details. Required when is_redirect is false (direct flow).", "allOf":[ { "$ref":"#/components/schemas/CardRequest" } ] }, "third_part_name":{ "type":"string", "description":"Third Part first name.", "example":"John" }, "third_part_last_name":{ "type":"string", "description":"Third Part last name.", "example":"Doe" }, "third_part_email":{ "type":"string", "description":"Third Part email address.", "example":"john.doe@zrobank.com" }, "third_part_phone":{ "type":"string", "description":"Third Part phone number.", "example":"+5511999999999" }, "third_part_document":{ "type":"string", "description":"Third Part document.", "example":"12345678901" }, "third_part_document_type":{ "type":"string", "description":"Third Part document type.", "enum":[ "DNI", "CE", "PAS", "PP", "RUT", "RUC", "CUIL", "CUIT", "CPF", "CNPJ" ], "example":"CPF" }, "third_part_address_city":{ "type":"string", "description":"User Address City.", "example":"São Paulo" }, "third_part_address_country":{ "type":"string", "description":"User Address Country.", "example":"Brazil" }, "third_part_address_number":{ "type":"string", "description":"User Address number.", "example":"10" }, "third_part_address_state":{ "type":"string", "description":"User Address state", "example":"SP" }, "third_part_address_street":{ "type":"string", "description":"User Address Street.", "example":"Alameda Santos" }, "third_part_address_zip_code":{ "type":"string", "description":"User Address Zip Code.", "example":"0975858" }, "third_part_address_complement":{ "type":"string", "description":"User Address Complement.", "example":"flat 1201" }, "third_part_address_neighborhood":{ "type":"string", "description":"User Address Neighborhood.", "example":"Downtown" }, "three_ds_authentication_id":{ "type":"string", "description":"3DS Authentication ID. Required for DEBIT payment method when is_redirect is false (direct flow). Optional when is_redirect is true (redirect flow).", "example":"0197b169-da6b-7ba2-b053-ce413ae39afd" }, "is_redirect":{ "type":"boolean", "description":"Whether to use redirect flow for payment processing. Default is true. If your company do not have a PCI certificate, you MUST send this field with \"true\"", "example":true }, "redirect_url":{ "type":"string", "description":"URL to redirect after payment completion. Required when is_redirect is true or undefined.", "example":"https://example.com/payment-success" }, "expiration_time_minutes":{ "type":"number", "description":"Payment expiration time in minutes. Required when is_redirect is true or undefined.", "example":30 }, "language":{ "type":"string", "description":"Language for the payment interface. Required when is_redirect is true or undefined.", "example":"pt-BR" } }, "required":[ "country", "payment_method", "amount_total", "currency_tag", "third_part_name", "third_part_last_name", "third_part_email", "third_part_phone", "third_part_document", "third_part_document_type", "third_part_address_city", "third_part_address_country", "third_part_address_number", "third_part_address_state", "third_part_address_street", "third_part_address_zip_code", "third_part_address_complement" ] }, "V1CreateCashDepositBody":{ "type":"object", "properties":{ "country":{ "type":"string", "description":"Country ISO 3166-1-alpha-3 code for the payment.", "enum":[ "CHL", "PER", "ARG" ], "example":"CHL" }, "payment_method":{ "type":"string", "description":"Payment method used in the transaction.", "enum":[ "CASH" ], "example":"CASH" }, "amount_total":{ "type":"number", "description":"Payment amount in cents. Min value is 100 cents.", "example":10000 }, "currency_tag":{ "description":"Payment currency ISO 4217 code", "example":"CLP", "oneOf":[ { "type":"string", "enum":[ "CLP" ], "description":"Currencies for Chile" }, { "type":"string", "enum":[ "PEN" ], "description":"Currencies for Peru" }, { "type":"string", "enum":[ "ARS" ], "description":"Currencies for Argentina" } ] }, "language":{ "type":"string", "description":"Language ISO 639-1 code for the payment.", "enum":[ "pt", "en", "es" ], "example":"en" }, "expiration_time_minutes":{ "type":"number", "description":"Expiration time in minutes for the payment. Default is 48 hours (2 days).", "example":2880 }, "third_part_name":{ "type":"string", "description":"Third Part first name.", "example":"John" }, "third_part_last_name":{ "type":"string", "description":"Third Part last name.", "example":"Doe" }, "third_part_email":{ "type":"string", "description":"Third Part email address.", "example":"john.doe@zrobank.com" }, "third_part_phone":{ "type":"string", "description":"Third Part phone number.", "example":"+5511999999999" }, "third_part_document":{ "type":"string", "description":"Third Part document.", "example":"12345678901" }, "third_part_document_type":{ "description":"Third Part document type.", "example":"RUT", "oneOf":[ { "type":"string", "enum":[ "RUT", "PP" ], "description":"Document types for Chile." }, { "type":"string", "enum":[ "DNI", "CE", "PAS" ], "description":"Document types for Peru." }, { "type":"string", "enum":[ "DNI", "CUIT", "CUIL" ], "description":"Document types for Argentina." } ] }, "third_part_address_zip_code":{ "type":"string", "description":"User Address Zip Code.", "example":"0975858" }, "third_part_address_street":{ "type":"string", "description":"User Address Street.", "example":"Alameda Santos" }, "third_part_address_number":{ "type":"string", "description":"User Address number.", "example":"10" }, "third_part_address_city":{ "type":"string", "description":"User Address City.", "example":"São Paulo" }, "third_part_address_state":{ "type":"string", "description":"User Address State.", "example":"SP" }, "third_part_address_country":{ "type":"string", "description":"User Address Country.", "example":"Brazil" }, "third_part_address_complement":{ "type":"string", "description":"User Address Complement.", "example":"flat 1201" }, "redirect_url":{ "type":"string", "description":"Redirect URL for payment success and error.", "example":"https://example.com/my-home-page" } }, "required":[ "country", "payment_method", "amount_total", "currency_tag", "language", "third_part_name", "third_part_last_name", "third_part_email", "third_part_phone", "third_part_document", "third_part_document_type", "third_part_address_zip_code", "third_part_address_street", "third_part_address_number", "third_part_address_city", "third_part_address_state", "third_part_address_country", "redirect_url" ] }, "V1CreateBankTransferDepositBody":{ "type":"object", "properties":{ "country":{ "type":"string", "description":"Country ISO 3166-1-alpha-3 code for the payment.", "enum":[ "CHL", "PER", "ARG" ], "example":"PER" }, "payment_method":{ "type":"string", "description":"Payment method used in the transaction.", "enum":[ "BANK_TRANSFER" ], "example":"BANK_TRANSFER" }, "amount_total":{ "type":"number", "description":"Payment amount in cents. Min value is 100 cents.", "example":10000 }, "currency_tag":{ "type":"number", "description":"Payment currency ISO 4217 code ", "example":"CLP", "enum":[ [ "CLP" ], [ "PEN" ], [ "ARS" ] ] }, "third_part_name":{ "type":"string", "description":"Third Part first name.", "example":"John" }, "third_part_last_name":{ "type":"string", "description":"Third Part last name.", "example":"Doe" }, "third_part_email":{ "type":"string", "description":"Third Part email address.", "example":"john.doe@zrobank.com" }, "third_part_phone":{ "type":"string", "description":"Third Part phone number.", "example":"+5511999999999" }, "third_part_document":{ "type":"string", "description":"Third Part document.", "example":"12345678901" }, "third_part_document_type":{ "type":"string", "description":"Third Part document type.", "enum":[ "DNI", "RUT", "PAS", "CE", "RUC", "CUIL", "CUIT" ], "example":"RUT" }, "third_part_address_zip_code":{ "type":"string", "description":"User Address Zip Code.", "example":"0975858" }, "third_part_address_street":{ "type":"string", "description":"User Address Street.", "example":"Alameda Santos" }, "third_part_address_number":{ "type":"string", "description":"User Address number.", "example":10 }, "third_part_address_city":{ "type":"string", "description":"User Address City.", "example":"São Paulo" }, "third_part_address_state":{ "type":"string", "description":"User Address state.", "example":"SP" }, "third_part_address_country":{ "type":"string", "description":"User Address Country.", "example":"Brazil" }, "third_part_address_complement":{ "type":"string", "description":"User Address Complement.", "example":"flat 1201" }, "expiration_time_minutes":{ "type":"number", "description":"Expiration time in minutes.", "example":30 }, "language":{ "type":"string", "description":"Language.", "example":"en" }, "redirect_url":{ "type":"string", "description":"Redirect URL for payment success and error.", "example":"https://example.com/payment/my-home-page" }, "cbu":{ "type":"string", "description":"CBU (Clave Bancaria Uniforme) for Argentina bank transfers.", "example":"1234567890123456789012" }, "cuit":{ "type":"string", "description":"CUIT (Código Único de Identificación Tributaria) for Argentina bank transfers.", "example":"20123456789" } }, "required":[ "country", "payment_method", "amount_total", "currency_tag", "third_part_name", "third_part_last_name", "third_part_email", "third_part_phone", "third_part_document", "third_part_document_type", "third_part_address_zip_code", "third_part_address_street", "third_part_address_number", "third_part_address_city", "third_part_address_state", "third_part_address_country", "third_part_address_complement", "expiration_time_minutes", "language", "redirect_url" ] }, "V1CreatePayinResponse":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Payin ID.", "example":"0197b169-da6b-7ba2-b053-ce413ae39afd" }, "status":{ "type":"string", "description":"Payin status.", "example":"PENDING" }, "created_at":{ "format":"date-time", "type":"string", "description":"Payin creation date.", "example":"2025-10-22T15:30:01.715Z" }, "updated_at":{ "format":"date-time", "type":"string", "description":"Payin update date.", "example":"2025-10-22T15:30:01.715Z" } }, "required":[ "id", "status", "created_at", "updated_at" ] }, "V1CancelPayinRestResponse":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Payin ID", "example":"0197b169-da6b-7ba2-b053-ce413ae39afd" }, "status":{ "type":"string", "description":"Current payin status", "enum":[ "PENDING", "WAITING", "WAITING_THREE_DS", "AUTHORIZED", "EXPIRED", "DECLINED", "REVERTED", "CANCELLATION_IN_PROGRESS", "CANCELLED", "SETTLED", "REFUNDED", "FAILED" ], "example":"CONFIRMED" }, "createdAt":{ "format":"date-time", "type":"string", "description":"Payin creation date", "example":"2023-01-01T10:00:00.000Z" }, "updatedAt":{ "format":"date-time", "type":"string", "description":"Payin last update date", "example":"2023-01-01T11:00:00.000Z" } }, "required":[ "id", "status", "createdAt", "updatedAt" ] }, "V1CreateThreeDsBody":{ "type":"object", "properties":{ "country":{ "type":"string", "description":"Country code for the payment.", "example":"BR" }, "payment_method":{ "type":"string", "description":"Payment method used in the transaction.", "enum":[ "DEBIT_CARD" ], "example":"DEBIT_CARD" }, "amount_total":{ "type":"number", "description":"Payment amount in cents. Min value is 1000 cents.", "example":10000 }, "currency_tag":{ "type":"string", "description":"Payment currency tag.", "example":"BRL", "enum":[ "BRL", "USD" ] }, "third_part_name":{ "type":"string", "description":"Third Part name. It must contain at least first name and last name.", "example":"John Doe" }, "third_part_email":{ "type":"string", "description":"Third Part email address.", "example":"john.doe@zrobank.com" }, "third_part_phone":{ "type":"string", "description":"Third Part phone number.", "example":"+5511999999999" }, "third_part_address_zip_code":{ "type":"string", "description":"User Address Zip Code.", "example":"0975858" }, "third_part_address_street":{ "type":"string", "description":"User Address Street.", "example":"Alameda Santos" }, "third_part_address_number":{ "type":"string", "description":"User Address number.", "example":"10" }, "third_part_address_city":{ "type":"string", "description":"User Address City.", "example":"São Paulo" }, "third_part_address_federative_unit":{ "type":"string", "description":"User Address Federative Unit.", "example":"SP" }, "third_part_address_country":{ "type":"string", "description":"User Address Country.", "example":"Brazil" }, "third_part_address_neighborhood":{ "type":"string", "description":"User Address Neighborhood.", "example":"Downtown" }, "third_part_address_complement":{ "type":"string", "description":"User Address Complement.", "example":"flat 1201" }, "third_part_navigator_language":{ "type":"string", "description":"Browser language.", "example":"en-US" }, "third_part_navigator_java_enabled":{ "type":"boolean", "description":"Java enabled status.", "example":false }, "third_part_navigator_color_depth":{ "type":"number", "description":"Color depth in bits.", "example":24 }, "third_part_navigator_screen_height":{ "type":"number", "description":"Screen height in pixels.", "example":768 }, "third_part_navigator_screen_width":{ "type":"number", "description":"Screen width in pixels.", "example":1366 }, "third_part_navigator_time_difference":{ "type":"number", "description":"Time difference in minutes.", "example":180 }, "third_part_navigator_user_agent":{ "type":"string", "description":"User agent string.", "example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.3" }, "third_part_navigator_http_accept_content":{ "type":"string", "description":"HTTP Accept content.", "example":"*/*" }, "merchant_url":{ "type":"string", "description":"Merchant URL.", "example":"https://www.merchant.com" }, "merchant_challenge_window_size":{ "type":"string", "description":"Merchant Challenge Window Size.", "example":"FULL_PAGE", "enum":[ "SMALL", "MEDIUM", "LARGE", "XLARGE", "FULL_PAGE" ] }, "merchant_transaction_mode":{ "type":"string", "description":"Merchant Transaction Mode.", "example":"ECOMMERCE", "enum":[ "ECOMMERCE", "MOBILE", "TABLET" ] }, "device_channel":{ "type":"string", "description":"Device channel.", "example":"BROWSER", "enum":[ "SDK", "BROWSER" ] }, "payment_card":{ "description":"Payment card details.", "allOf":[ { "$ref":"#/components/schemas/CardRequest" } ] } }, "required":[ "country", "payment_method", "amount_total", "currency_tag", "third_part_name", "third_part_email", "third_part_phone", "third_part_address_zip_code", "third_part_address_street", "third_part_address_number", "third_part_address_city", "third_part_address_federative_unit", "third_part_address_country", "third_part_address_complement", "third_part_navigator_language", "third_part_navigator_java_enabled", "third_part_navigator_color_depth", "third_part_navigator_screen_height", "third_part_navigator_screen_width", "third_part_navigator_time_difference", "third_part_navigator_user_agent", "third_part_navigator_http_accept_content", "merchant_url", "merchant_challenge_window_size", "merchant_transaction_mode", "device_channel", "payment_card" ] }, "V1CreateThreeDsRestResponse":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Three DS authentication ID.", "example":"0197b169-da6b-7ba2-b053-ce413ae39afd" }, "status":{ "type":"string", "description":"Three DS authentication status.", "example":"FAILED", "enum":[ "PENDING", "WAITING_AUTHENTICATION", "WAITING_CHALLENGE", "ACCEPTED", "REJECTED", "FAILED", "ERROR" ] }, "created_at":{ "format":"date-time", "type":"string", "description":"Three DS authentication creation date.", "example":"2025-10-22T15:30:01.717Z" }, "updated_at":{ "format":"date-time", "type":"string", "description":"Three DS authentication last update date.", "example":"2025-10-22T15:30:01.717Z" } }, "required":[ "id", "status", "created_at", "updated_at" ] }, "ChallengeDataResponse":{ "type":"object", "properties":{ "access_token":{ "type":"string", "description":"Access Token to be used in the challenge step up URL.", "example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." }, "step_up_url":{ "type":"string", "description":"Step Up URL provided by the 3DS provider.", "example":"https://3ds-provider.com/challenge" }, "authentication_id":{ "type":"string", "description":"Authentication ID for tracking the challenge session.", "example":"auth123" }, "iframe_dimension_width":{ "type":"string", "description":"Width of the iframe to be used for the challenge (e.g., \"400px\").", "example":"400px" }, "iframe_dimension_height":{ "type":"string", "description":"Height of the iframe to be used for the challenge (e.g., \"600px\").", "example":"600px" } }, "required":[ "access_token", "step_up_url", "authentication_id", "iframe_dimension_width", "iframe_dimension_height" ] }, "V1GetThreeDsByIdRestResponse":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Three DS Authentication ID.", "example":"0197b169-da6b-7ba2-b053-ce413ae39afd" }, "user_id":{ "type":"string", "description":"User ID of the merchant who performed the transaction.", "example":"123e4567-e89b-12d3-a456-426614174000" }, "country":{ "type":"string", "description":"Country Of Transaction.", "example":"BR" }, "payment_method":{ "type":"string", "description":"Payment Method.", "enum":[ "DEBIT_CARD", "CREDIT_CARD" ], "example":"CREDIT_CARD" }, "amount":{ "type":"number", "description":"Payment Value.", "example":100 }, "currency_tag":{ "type":"string", "description":"Payment Currency Tag.", "enum":[ "BRL", "USD" ], "example":"BRL" }, "status":{ "type":"string", "description":"Transaction Status.", "enum":[ "PENDING", "WAITING_AUTHENTICATION", "WAITING_CHALLENGE", "ACCEPTED", "REJECTED", "FAILED", "ERROR" ], "example":"PENDING" }, "third_part_name":{ "type":"string", "description":"Third Part Full Name.", "example":"John Doe" }, "third_part_email":{ "type":"string", "description":"Third Part Email Address.", "example":"john.doe@example.com" }, "third_part_phone_number":{ "type":"string", "description":"Third Part Phone Number.", "example":"+5511999998888" }, "third_part_address_city":{ "type":"string", "description":"Third Part Address City.", "example":"São Paulo" }, "third_part_address_country":{ "type":"string", "description":"Third Part Address Country.", "example":"BR" }, "third_part_address_federative_unit":{ "type":"string", "description":"Third Part Address Federative Unit.", "example":"SP" }, "third_part_address_number":{ "type":"string", "description":"Third Part Address Number.", "example":"123" }, "third_part_address_street":{ "type":"string", "description":"Third Part Address Street.", "example":"Avenida Paulista" }, "third_part_address_zip_code":{ "type":"string", "description":"Third Part Address Zip Code.", "example":"01311000" }, "third_part_address_complement":{ "type":"string", "description":"Third Part Address Complement.", "example":"Apto 101" }, "third_part_address_neighborhood":{ "type":"string", "description":"Third Part Address Neighborhood.", "example":"Bela Vista" }, "third_part_navigator_language":{ "type":"string", "description":"Browser language.", "example":"en-US" }, "third_part_navigator_java_enabled":{ "type":"boolean", "description":"Java enabled status.", "example":false }, "third_part_navigator_color_depth":{ "type":"number", "description":"Color depth in bits.", "example":24 }, "third_part_navigator_screen_height":{ "type":"number", "description":"Screen height in pixels.", "example":768 }, "third_part_navigator_screen_width":{ "type":"number", "description":"Screen width in pixels.", "example":1366 }, "third_part_navigator_time_difference":{ "type":"number", "description":"Time difference in minutes.", "example":180 }, "third_part_navigator_user_agent":{ "type":"string", "description":"User agent string.", "example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.3" }, "third_part_navigator_http_accept_content":{ "type":"string", "description":"HTTP Accept content.", "example":"*/*" }, "merchant_url":{ "type":"string", "description":"Merchant URL.", "example":"https://www.merchant.com" }, "merchant_challenge_window_size":{ "type":"string", "description":"Merchant Challenge Window Size.", "example":"FULL_PAGE", "enum":[ "SMALL", "MEDIUM", "LARGE", "XLARGE", "FULL_PAGE" ] }, "merchant_transaction_mode":{ "type":"string", "description":"Merchant Transaction Mode.", "example":"ECOMMERCE", "enum":[ "ECOMMERCE", "MOBILE", "TABLET" ] }, "device_channel":{ "type":"string", "description":"Device channel.", "example":"BROWSER", "enum":[ "SDK", "BROWSER" ] }, "challenge_data":{ "description":"Challenge URL.", "example":{ "access_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "step_up_url":"https://3ds-provider.com/challenge", "authentication_id":"auth123", "iframe_dimension_width":"400px", "iframe_dimension_height":"600px" }, "allOf":[ { "$ref":"#/components/schemas/ChallengeDataResponse" } ] }, "created_at":{ "format":"date-time", "type":"string", "description":"Transaction creation date", "example":"2023-01-01T10:00:00.000Z" }, "updated_at":{ "format":"date-time", "type":"string", "description":"Transaction last update date", "example":"2023-01-01T11:00:00.000Z" } }, "required":[ "id", "user_id", "country", "payment_method", "amount", "currency_tag", "status", "third_part_name", "third_part_email", "third_part_phone_number", "third_part_address_city", "third_part_address_country", "third_part_address_federative_unit", "third_part_address_number", "third_part_address_street", "third_part_address_zip_code", "third_part_navigator_language", "third_part_navigator_java_enabled", "third_part_navigator_color_depth", "third_part_navigator_screen_height", "third_part_navigator_screen_width", "third_part_navigator_time_difference", "third_part_navigator_user_agent", "third_part_navigator_http_accept_content", "merchant_url", "merchant_challenge_window_size", "merchant_transaction_mode", "device_channel", "created_at", "updated_at" ] }, "V1GetBankTransferPaymentByIdResponse":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Payout ID.", "example":"0197b169-da6b-7ba2-b053-ce413ae39afd" }, "operation_id":{ "type":"string", "description":"Operation ID associated with the transaction.", "example":"456e7890-e12b-34d5-a678-426614174001" }, "country":{ "type":"string", "description":"Country of the transaction.", "example":"ARG", "enum":[ "BRA", "ARG", "CHL", "PER" ] }, "status":{ "type":"string", "description":"Status of the transaction.", "example":"PENDING", "enum":[ "PENDING", "WAITING", "AUTHORIZED", "REJECTED", "REVERSED", "PROCESSED", "FAILED", "ERROR" ] }, "amount":{ "type":"number", "description":"Amount of the transaction.", "example":100 }, "currency_tag":{ "type":"object", "description":"Currency of the transaction.", "example":"PEN" }, "third_part_name":{ "type":"string", "description":"Third part name.", "example":"John Doe" }, "third_part_last_name":{ "type":"string", "description":"Third part last name.", "example":"Doe" }, "third_part_email":{ "type":"string", "description":"Third part email.", "example":"john.doe@example.com" }, "third_part_phone":{ "type":"string", "description":"Third part phone.", "example":"+5511999998888" }, "third_part_document":{ "type":"string", "description":"Third part document.", "example":"12345678901" }, "third_part_document_type":{ "type":"object", "description":"Third part document type.", "example":"DNI" }, "third_part_address_zip_code":{ "type":"string", "description":"Third part address zip code.", "example":"01311000" }, "third_part_address_street":{ "type":"string", "description":"Third part address street.", "example":"Avenida Paulista" }, "third_part_address_number":{ "type":"string", "description":"Third part address number.", "example":"123" }, "third_part_address_city":{ "type":"string", "description":"Third part address city.", "example":"São Paulo" }, "third_part_address_state":{ "type":"string", "description":"Third part address state.", "example":"SP" }, "third_part_address_country":{ "type":"string", "description":"Third part address country.", "example":"BR" }, "third_part_address_complement":{ "type":"string", "description":"Third part address complement.", "example":"Apto 101" }, "third_part_account_type":{ "type":"string", "description":"Third part account type.", "example":"SA", "enum":[ "SA", "CA", "CP" ] }, "third_part_account_number":{ "type":"string", "description":"Third part account number.", "example":"123456789" }, "third_part_bank_code":{ "type":"string", "description":"Third part bank code.", "example":"001" }, "authorized_date":{ "format":"date-time", "type":"string", "description":"Authorized date.", "example":"2025-10-22T15:30:01.718Z" }, "failed_date":{ "format":"date-time", "type":"string", "description":"Failed date.", "example":"2025-10-22T15:30:01.718Z" }, "created_at":{ "format":"date-time", "type":"string", "description":"Created at.", "example":"2025-10-22T15:30:01.718Z" }, "updated_at":{ "format":"date-time", "type":"string", "description":"Updated at.", "example":"2025-10-22T15:30:01.718Z" } }, "required":[ "id", "country", "status", "amount", "currency_tag", "third_part_name", "third_part_last_name", "third_part_email", "third_part_phone", "third_part_document", "third_part_document_type", "third_part_address_zip_code", "third_part_address_street", "third_part_address_number", "third_part_address_city", "third_part_address_state", "third_part_address_country", "third_part_account_type", "third_part_account_number", "third_part_bank_code", "authorized_date", "failed_date", "created_at", "updated_at" ] }, "V1CreatePayoutBody":{ "type":"object", "properties":{ "country":{ "type":"string", "description":"Country ISO 3166-1-alpha-3 code for the payment.", "enum":[ "CHL", "ARG", "PER" ], "example":"PER" }, "payment_method":{ "type":"string", "description":"Payment method used in the transaction.", "enum":[ "BANK_TRANSFER" ], "example":"BANK_TRANSFER" }, "amount_total":{ "type":"number", "description":"Payment amount in cents. Min value is 1000 cents.", "example":10000 }, "currency_tag":{ "type":"string", "description":"Payment currency ISO 4217 code ", "example":"CLP", "enum":[ "CLP", "ARS", "PEN" ] }, "third_part_name":{ "type":"string", "description":"Third Part first name.", "example":"John" }, "third_part_last_name":{ "type":"string", "description":"Third Part last name.", "example":"Doe" }, "third_part_email":{ "type":"string", "description":"Third Part email address.", "example":"john.doe@zrobank.com" }, "third_part_phone":{ "type":"string", "description":"Third Part phone number.", "example":"+5511999999999" }, "third_part_document":{ "type":"string", "description":"Third Part document.", "example":"12345678901" }, "third_part_document_type":{ "type":"string", "description":"Third Part document type.", "enum":[ "DNI", "RUT", "PAS", "CE", "RUC", "CUIL", "CUIT" ], "example":"RUT" }, "third_part_address_zip_code":{ "type":"string", "description":"User Address Zip Code.", "example":"0975858" }, "third_part_address_street":{ "type":"string", "description":"User Address Street.", "example":"Alameda Santos" }, "third_part_address_number":{ "type":"string", "description":"User Address number.", "example":10 }, "third_part_address_city":{ "type":"string", "description":"User Address City.", "example":"São Paulo" }, "third_part_address_state":{ "type":"string", "description":"User Address state.", "example":"SP" }, "third_part_address_country":{ "type":"string", "description":"User Address Country.", "example":"Brazil" }, "third_part_address_complement":{ "type":"string", "description":"User Address Complement.", "example":"flat 1201" }, "third_part_bank_code":{ "type":"string", "description":"Bank identifier code (bank_code). To retrieve the valid value, call the endpoint GET /v1/payout/banks/:country. If the \"code\" field in the response is null, this field must also remain null.", "example":"001" }, "third_part_account_type":{ "type":"string", "description":"Account Type. Mapping: SA = Savings Account, CA = Checking Account, CP = Cell Phone / Mobile Wallet.", "example":"SA", "enum":[ "SA", "CA", "CP" ] }, "third_part_account_number":{ "type":"string", "description":"Account Number.", "example":"123456789" } }, "required":[ "country", "payment_method", "amount_total", "currency_tag", "third_part_name", "third_part_last_name", "third_part_email", "third_part_phone", "third_part_document", "third_part_document_type", "third_part_address_zip_code", "third_part_address_street", "third_part_address_number", "third_part_address_city", "third_part_address_state", "third_part_address_country", "third_part_account_type", "third_part_account_number" ] }, "V1CreateBankTransferPaymentBody":{ "type":"object", "properties":{ "country":{ "type":"string", "description":"Country ISO 3166-1-alpha-3 code for the payment.", "enum":[ "CHL", "PER", "ARG" ], "example":"PER" }, "payment_method":{ "type":"string", "description":"Payment method used in the transaction.", "enum":[ "BANK_TRANSFER" ], "example":"BANK_TRANSFER" }, "amount_total":{ "type":"number", "description":"Payment amount in cents. Min value is 100 cents.", "example":10000 }, "currency_tag":{ "type":"number", "description":"Payment currency ISO 4217 code ", "example":"CLP", "enum":[ [ "CLP" ], [ "PEN" ], [ "ARS" ] ] }, "third_part_name":{ "type":"string", "description":"Third Part first name.", "example":"John" }, "third_part_last_name":{ "type":"string", "description":"Third Part last name.", "example":"Doe" }, "third_part_email":{ "type":"string", "description":"Third Part email address.", "example":"john.doe@zrobank.com" }, "third_part_phone":{ "type":"string", "description":"Third Part phone number.", "example":"+5511999999999" }, "third_part_document":{ "type":"string", "description":"Third Part document.", "example":"12345678901" }, "third_part_document_type":{ "type":"string", "description":"Third Part document type.", "enum":[ "DNI", "RUT", "PAS", "CE", "RUC", "CUIL", "CUIT" ], "example":"DNI" }, "third_part_address_zip_code":{ "type":"string", "description":"User Address Zip Code.", "example":"0975858" }, "third_part_address_street":{ "type":"string", "description":"User Address Street.", "example":"Alameda Santos" }, "third_part_address_number":{ "type":"string", "description":"User Address number.", "example":10 }, "third_part_address_city":{ "type":"string", "description":"User Address City.", "example":"São Paulo" }, "third_part_address_state":{ "type":"string", "description":"User Address state.", "example":"SP" }, "third_part_address_country":{ "type":"string", "description":"User Address Country.", "example":"Brazil" }, "third_part_address_complement":{ "type":"string", "description":"User Address Complement.", "example":"flat 1201" }, "third_part_bank_code":{ "type":"string", "description":"Bank identifier code (bank_code). To retrieve the valid value, call the endpoint GET /v1/payout/banks/:country. If the \"code\" field in the response is null, this field must also remain null.", "example":"001" }, "third_part_account_type":{ "type":"string", "description":"Account Type. Mapping: SA = Savings Account, CA = Checking Account, CP = Cell Phone / Mobile Wallet.", "example":"SA", "enum":[ "SA", "CA", "CP" ] }, "third_part_account_number":{ "type":"string", "description":"\n Account Number rules by banks in Peru:\n\n - **BBVA Bank (001):** 18 or 20 digits \n Ex: 001106660100012345 (18) | (20) \n\n - **Bank of Credit (002):** \n • 14 digits for Savings Account \n\n - **Interbank (003):** 13 digits \n\n - **Scotiabank (004):** 10 digits (3 agency + 7 account) \n Ex: 0037651234 \n\n - **Other banks:** 20-digit CCI (Ex: 00219400254640654321) \n ", "example":"00110666010001234512" } }, "required":[ "country", "payment_method", "amount_total", "currency_tag", "third_part_name", "third_part_last_name", "third_part_email", "third_part_phone", "third_part_document", "third_part_document_type", "third_part_address_zip_code", "third_part_address_street", "third_part_address_number", "third_part_address_city", "third_part_address_state", "third_part_address_country", "third_part_account_type", "third_part_account_number" ] }, "V1CreatePayoutResponse":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Payout ID.", "example":"0197b169-da6b-7ba2-b053-ce413ae39afd" }, "status":{ "type":"string", "description":"Payout status.", "example":"PENDING" }, "created_at":{ "format":"date-time", "type":"string", "description":"Payout creation date.", "example":"2025-10-22T15:30:01.719Z" }, "updated_at":{ "format":"date-time", "type":"string", "description":"Payout update date.", "example":"2025-10-22T15:30:01.719Z" } }, "required":[ "id", "status", "created_at", "updated_at" ] }, "V1GetAllBankTransferPaymentResponseItem":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Payout ID.", "example":"0197b169-da6b-7ba2-b053-ce413ae39afd" }, "operation_id":{ "type":"string", "description":"Operation ID associated with the transaction.", "example":"456e7890-e12b-34d5-a678-426614174001" }, "country":{ "type":"object", "description":"Country of the transaction.", "example":"CHL" }, "status":{ "type":"object", "description":"Status of the transaction.", "example":"PENDING" }, "amount":{ "type":"number", "description":"Amount of the transaction.", "example":1000 }, "currency_tag":{ "type":"object", "description":"Currency tag of the transaction.", "example":"PEN" }, "third_part_name":{ "type":"string", "description":"Third party's first name.", "example":"John" }, "third_part_last_name":{ "type":"string", "description":"Third party's last name.", "example":"Doe" }, "third_part_email":{ "type":"string", "description":"Third party's email address.", "example":"john.doe@example.com" }, "third_part_phone":{ "type":"string", "description":"Third party's phone number.", "example":"+1234567890" }, "third_part_document":{ "type":"string", "description":"Third party's document number.", "example":"A12345678" }, "third_part_document_type":{ "type":"object", "description":"Third part document type.", "example":"DNI" }, "third_part_address_zip_code":{ "type":"string", "description":"Third party's address zip code.", "example":"12345" }, "third_part_address_street":{ "type":"string", "description":"Third party's address street.", "example":"Main St" }, "third_part_address_number":{ "type":"string", "description":"Third party's address number.", "example":"100" }, "third_part_address_city":{ "type":"string", "description":"Third party's address city.", "example":"Metropolis" }, "third_part_address_state":{ "type":"string", "description":"Third party's address state.", "example":"StateName" }, "third_part_address_country":{ "type":"string", "description":"Third party's address country.", "example":"CountryName" }, "third_part_address_complement":{ "type":"string", "description":"Third party's address complement.", "example":"Apt 101" }, "third_part_bank_code":{ "type":"string", "description":"Third party's bank code.", "example":"123" }, "third_part_account_type":{ "type":"string", "description":"Third party's account type.", "example":"CA", "enum":[ "SA", "CA", "CP" ] }, "third_part_account_number":{ "type":"string", "description":"Third party's account number.", "example":"1234567890" }, "authorized_date":{ "format":"date-time", "type":"string", "description":"Date when the transaction was authorized.", "example":"2023-10-01T12:00:00Z" }, "failed_date":{ "format":"date-time", "type":"string", "description":"Date when the transaction failed.", "example":"2023-10-03T12:00:00Z" }, "created_at":{ "format":"date-time", "type":"string", "description":"Creation date of the transaction record.", "example":"2023-09-30T12:00:00Z" }, "updated_at":{ "format":"date-time", "type":"string", "description":"Last update date of the transaction record.", "example":"2023-10-01T15:00:00Z" } }, "required":[ "id", "country", "status", "amount", "currency_tag", "third_part_name", "third_part_last_name", "third_part_phone", "third_part_document", "third_part_document_type", "third_part_address_zip_code", "third_part_address_street", "third_part_address_number", "third_part_address_city", "third_part_address_state", "third_part_address_country", "third_part_bank_code", "third_part_account_type", "third_part_account_number", "created_at", "updated_at" ] }, "V1GetAllBankTransferPaymentsResponse":{ "type":"object", "properties":{ "page":{ "type":"number", "description":"Page number.", "example":1 }, "page_size":{ "type":"number", "description":"Page size.", "example":20 }, "page_total":{ "type":"number", "description":"Page total.", "example":20 }, "total":{ "type":"number", "description":"Total of elements.", "example":100 }, "data":{ "description":"List of bank transfer payments.", "type":"array", "items":{ "$ref":"#/components/schemas/V1GetAllBankTransferPaymentResponseItem" } } }, "required":[ "page", "page_size", "page_total", "total", "data" ] }, "V1GetAllBankFinancialInstitutionsByCountryResponseItem":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Bank ID.", "example":"0197b169-da6b-7ba2-b053-ce413ae39afd" }, "country":{ "type":"object", "description":"Country of the bank.", "example":"ARG" }, "type":{ "type":"object", "description":"Bank type.", "example":"commercial" }, "code":{ "type":"string", "description":"Bank code.", "example":"001" }, "name":{ "type":"string", "description":"Bank name.", "example":"Bank of Example" }, "full_name":{ "type":"string", "description":"Full name of the bank.", "example":"The Bank of Example Corporation" }, "active":{ "type":"boolean", "description":"Indicates if the bank is active.", "example":true }, "created_at":{ "format":"date-time", "type":"string", "description":"Creation date of the deposit record.", "example":"2023-09-30T12:00:00Z" }, "updated_at":{ "format":"date-time", "type":"string", "description":"Last update date of the deposit record.", "example":"2023-10-01T15:00:00Z" } }, "required":[ "id", "country", "type", "code", "name", "full_name", "active", "created_at", "updated_at" ] }, "V1GetAllBankFinancialInstitutionsByCountryResponse":{ "type":"object", "properties":{ "page":{ "type":"number", "description":"Page number.", "example":1 }, "page_size":{ "type":"number", "description":"Page size.", "example":20 }, "page_total":{ "type":"number", "description":"Page total.", "example":20 }, "total":{ "type":"number", "description":"Total of elements.", "example":100 }, "data":{ "description":"Banks data.", "type":"array", "items":{ "$ref":"#/components/schemas/V1GetAllBankFinancialInstitutionsByCountryResponseItem" } } }, "required":[ "page", "page_size", "page_total", "total", "data" ] } } } }