{"openapi":"3.1.0","info":{"title":"DRUO Merchant API","version":"1.0.0","description":"Bank payments, payouts, transfers and recurring billing across the Americas."},"servers":[{"url":"https://api.druo.com"}],"security":[{"bearerAuth":[]}],"tags":[{"name":"Authentication"},{"name":"End Users"},{"name":"Connect Links"},{"name":"Accounts"},{"name":"Checkout Links"},{"name":"Payments"},{"name":"Payouts"},{"name":"Transfers"},{"name":"Recurring Plans"},{"name":"Balance & Deposits"},{"name":"Platforms"},{"name":"Acquirer Transactions"}],"paths":{"/oauth/token":{"post":{"operationId":"createToken","summary":"Create access token","description":"Generate a new OAuth access token. The generated token is valid for 86,400 seconds (24 hours) and includes its permitted scopes. It is recommended to cache and reuse tokens until they expire instead of requesting a new token for each API call.","tags":["Authentication"],"servers":[{"url":"https://auth.druo.com"}],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"client_id":{"type":"string","description":"The unique identifier of the client.","example":"ojT6MnDHwqCJDcfTIbmy"},"client_secret":{"type":"string","description":"The secret key associated with the client ID.","example":"5qmRkW64QELGZrv0MTq7IKj9aCIbLT"},"audience":{"type":"string","description":"The API identifier representing the target audience.","example":"https://druo-merchant-api.com"},"grant_type":{"type":"string","description":"The OAuth grant type requested.","enum":["client_credentials"],"example":"client_credentials"}},"required":["client_id","client_secret","audience","grant_type"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"access_token":{"type":"string","description":"The generated JSON Web Token (JWT) used for authentication.","example":"eyJhbGciOiJSUzI1NiIsInR..."},"scope":{"type":"string","description":"The space-separated list of scopes granted to the access token.","example":"read:connect write:transaction"},"expires_in":{"type":"integer","description":"The lifetime of the access token in seconds from the time of generation.","example":86400},"token_type":{"type":"string","description":"The type of token returned.","example":"Bearer"}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/end-users/create":{"post":{"operationId":"createEndUser","summary":"Create End User","description":"Creates a new End User representing an individual or an organization. This endpoint creates an End User object. End Users can be either individuals (humans) or organizations (companies), and store associated identity details, contact information, and billing addresses.","tags":["End Users"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"The type of end user. Must be either INDIVIDUAL or ORGANIZATION.","enum":["INDIVIDUAL","ORGANIZATION"],"example":"INDIVIDUAL"},"email":{"type":"string","description":"The user's email address.","example":"john.doe@example.com"},"first_name":{"type":"string","description":"The user's first name. Required if type is INDIVIDUAL.","example":"John"},"last_name":{"type":"string","description":"The user's last name. Required if type is INDIVIDUAL.","example":"Smith"},"organization":{"type":"string","description":"The organization's name. Required if type is ORGANIZATION.","example":"DRUO"},"local_id":{"type":"string","description":"The user's national or local identification number. For Mexico, use the 13-digit RFC. Required for merchants in Colombia.","example":"45235553"},"local_id_type":{"type":"string","description":"The user's ID type.","example":"NATIONAL_ID"},"local_id_country":{"type":"string","description":"The user's citizenship in 3-letter ISO code.","example":"COL"},"phone_number":{"type":"object","description":"The user's phone number.","example":{"number":"3223306031","country_code":"51"},"properties":{"country_code":{"type":"string","description":"The country code for the user's phone number."},"number":{"type":"string","description":"The user's phone number without country code."}},"required":["country_code","number"]},"merchant_id":{"type":"string","description":"The merchant ID associated with this end user.","example":"mer_fe1b01b8-66f9-4bef-be36-5cb2ebacc004"},"date_of_birth":{"type":"string","description":"The user's date of birth in YYYY-MM-DD format.","example":"2021-07-19"},"address":{"type":"object","description":"The user's address details.","example":{"address_line_1":"Calle 1 # 19A - 91","locality":"Bogota","country":"COL"},"properties":{"address_line_1":{"type":"string","description":"Address line 1."},"address_line_2":{"type":"string","description":"Address line 2."},"address_line_3":{"type":"string","description":"Address line 3."},"locality":{"type":"string","description":"Locality of the provided address."},"sublocality":{"type":"string","description":"Sublocality of the provided address."},"administrative_district":{"type":"string","description":"Administrative district of the provided address."},"postal_code":{"type":"string","description":"Postal code of the provided address."},"country":{"type":"string","description":"Country of the provided address as a 3-letter ISO code."}}},"preferred_language":{"type":"string","description":"The user's preferred language, used for system notifications.","example":"en_US"},"note":{"type":"string","description":"A custom note associated with this end user.","example":"This is a special customer."},"primary_reference":{"type":"string","description":"The End User's primary reference. Can be any value to associate the end user to an entity in an external system.","example":"23423524"},"secondary_reference":{"type":"string","description":"The End User's secondary reference. Can be any value to associate the end user to an entity in an external system.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long.","example":{"order_id":"6735"}}},"required":["type","email","first_name","last_name","organization","local_id","local_id_type","local_id_country","phone_number"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The End User's UUID.","example":"eur_747536f4-1efd-4cad-91b3-cc8aaeed93e3"},"code":{"type":"string","description":"The End User's code.","example":"ECSCDSVFGH"},"type":{"type":"string","description":"The type of end user. Whether a company or an individual.","example":"COMPANY"},"first_name":{"type":"string","description":"The user's first name.","example":"John"},"last_name":{"type":"string","description":"The user's last name.","example":"Smith"},"organization":{"type":"string","description":"The organization's name.","example":"DRUO"},"local_id":{"type":"string","description":"The user's ID number.","example":"45235553"},"local_id_type":{"type":"string","description":"The user's ID type.","example":"NATIONAL_ID"},"local_id_country":{"type":"string","description":"The user's citizenship in 3-letter ISO code.","example":"COL"},"date_of_birth":{"type":"string","description":"The user's date of birth in YYYY-MM-DD format.","example":"2021-07-19"},"email":{"type":"string","description":"The user's email address.","example":"john.smith@gmail.com"},"phone_number":{"type":"object","description":"The user's phone number details.","example":{"country_code":57,"number":3002328080},"properties":{"country_code":{"type":"string","description":"The phone number's country code."},"number":{"type":"integer","description":"The phone number without country code."}}},"address":{"type":"object","description":"The user's address details.","example":{"address_line_1":"Calle 1 # 19A - 91","address_line_2":"Casa","address_line_3":"#2","locality":"4","sublocality":"k","administrative_district":"fo","postal_code":"111101","country":"COL"},"properties":{"address_line_1":{"type":"string","description":"Address line 1."},"address_line_2":{"type":"string","description":"Address line 2."},"address_line_3":{"type":"string","description":"Address line 3."},"locality":{"type":"string","description":"Locality of the provided address."},"sublocality":{"type":"string","description":"Sublocality of the provided address."},"administrative_district":{"type":"string","description":"Administrative district of the provided address."},"postal_code":{"type":"string","description":"Postal code of the provided address."},"country":{"type":"string","description":"Country of the provided address."}}},"preferred_language":{"type":"string","description":"The user's preferred language. Used for system notifications.","example":"en_US"},"note":{"type":"string","description":"A custom note associated with this end user.","example":"This is a special customer."},"primary_reference":{"type":"string","description":"The End User's primary reference. Can be any value to associate the end user to an entity in an external system.","example":"23423524"},"secondary_reference":{"type":"string","description":"The End User's secondary reference. Can be any value to associate the end user to an entity in an external system.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object.","example":{"order_id":"6735"}},"creation_source":{"type":"string","description":"The channel through which the end user was created.","example":"API"},"date_created_gmt":{"type":"string","description":"The date and time the end user was created in GMT.","example":"2021-11-15T23:23:38Z"},"date_updated_gmt":{"type":"string","description":"The date and time the end user was last updated in GMT.","example":"2021-11-15T23:23:38Z"}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/end-users/{end_user_uuid}":{"get":{"operationId":"getEndUser","summary":"Get End User","description":"Retrieve the details of an existing End User. Returns the profile, contact details, and system configuration for a specific end user using their unique UUID.","tags":["End Users"],"parameters":[{"name":"end_user_uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The End User's unique identifier.","example":"eur_747536f4-1efd-4cad-91b3-cc8aaeed93e3"},"code":{"type":"string","description":"The End User's code.","example":"ECSCDSVFGH"},"type":{"type":"string","description":"The entity type of the End User.","enum":["COMPANY","INDIVIDUAL"],"example":"COMPANY"},"first_name":{"type":"string","description":"The user's first name.","example":"John"},"last_name":{"type":"string","description":"The user's last name.","example":"Smith"},"organization":{"type":"string","description":"The organization's name.","example":"DRUO"},"local_id":{"type":"string","description":"The user's identification number.","example":"45235553"},"local_id_type":{"type":"string","description":"The user's identification document type.","example":"NATIONAL_ID"},"local_id_country":{"type":"string","description":"The user's country of citizenship as a 3-letter ISO country code.","example":"COL"},"date_of_birth":{"type":"string","description":"The user's date of birth in YYYY-MM-DD format.","example":"2021-07-19"},"email":{"type":"string","description":"The user's email address.","example":"john.smith@gmail.com"},"phone_number":{"type":"object","description":"The user's phone number details.","example":{"country_code":"1","number":2025550198},"properties":{"country_code":{"type":"string","description":"The user's phone number country code."},"number":{"type":"integer","description":"The user's phone number without the country code."}},"required":["country_code","number"]},"address":{"type":"object","description":"The user's physical address.","example":{"address_line_1":"1600 Pennsylvania Ave NW","address_line_2":"Apt 101","locality":"Washington","administrative_district":"DC","postal_code":"20500","country":"USA"},"properties":{"address_line_1":{"type":"string","description":"Address line 1 (e.g., street, number)."},"address_line_2":{"type":"string","description":"Address line 2 (e.g., apartment, suite)."},"address_line_3":{"type":"string","description":"Address line 3 (additional information)."},"locality":{"type":"string","description":"Locality or city of the provided address."},"sublocality":{"type":"string","description":"Sublocality or neighborhood of the provided address."},"administrative_district":{"type":"string","description":"Administrative district, state, or province of the provided address."},"postal_code":{"type":"string","description":"Postal code of the provided address."},"country":{"type":"string","description":"The 3-letter ISO country code of the provided address."}},"required":["address_line_1","locality","administrative_district","postal_code","country"]},"preferred_language":{"type":"string","description":"The user's preferred language, used for system notifications.","example":"en_US"},"note":{"type":"string","description":"A custom note associated with this end user.","example":"This is a special customer."},"primary_reference":{"type":"string","description":"The End User's primary reference used to associate the user with an external system.","example":"23423524"},"secondary_reference":{"type":"string","description":"The End User's secondary reference used to associate the user with an external system.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"object","description":"A set of key-value pairs that you can attach to the object, with up to 50 keys, key names up to 40 characters long, and values up to 500 characters long.","example":{"order_id":"6735"}},"creation_source":{"type":"string","description":"The channel through which the end user was created.","example":"API"},"date_created_gmt":{"type":"string","description":"The creation timestamp of the end user in GMT ISO 8601 format.","example":"2021-11-15T23:23:38Z"},"date_updated_gmt":{"type":"string","description":"The last updated timestamp of the end user in GMT ISO 8601 format.","example":"2021-11-15T23:23:38Z"}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/end-users/list":{"get":{"operationId":"listEndUsers","summary":"List End Users","description":"Retrieve a list of existing End Users associated with a business. This endpoint supports advanced filtering and search capabilities using query parameters such as UUID and email.","tags":["End Users"],"parameters":[{"name":"uuid","in":"query","required":false,"description":"Filter the list of end users by their unique identifier.","schema":{"type":"string"}},{"name":"end_user_email","in":"query","required":false,"description":"Filter the list of end users by their email address.","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"The page number to return. Starts at 1.","schema":{"type":"integer"}},{"name":"page_size","in":"query","required":false,"description":"The number of items per page. Defaults to 1000 when omitted.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","description":"The End User's UUID.","example":"eur_747536f4-1efd-4cad-91b3-cc8aaeed93e3"},"code":{"type":"string","description":"The End User's code.","example":"ECSCDSVFGH"},"type":{"type":"string","description":"The type of end user, representing either a company or an individual.","example":"COMPANY"},"first_name":{"type":"string","description":"The user's first name.","example":"John"},"last_name":{"type":"string","description":"The user's last name.","example":"Smith"},"organization":{"type":"string","description":"The organization's name.","example":"DRUO"},"local_id":{"type":"string","description":"The user's ID number.","example":"45235553"},"local_id_type":{"type":"string","description":"The user's ID type.","example":"NATIONAL_ID"},"local_id_country":{"type":"string","description":"The user's citizenship country as a 3-letter ISO code.","example":"COL"},"date_of_birth":{"type":"string","description":"The user's date of birth in YYYY-MM-DD format.","example":"2021-07-19"},"email":{"type":"string","description":"The user's email address.","example":"john.smith@gmail.com"},"phone_number":{"type":"object","description":"The user's phone number details.","example":{"country_code":"57","number":"3002328080"},"properties":{"country_code":{"type":"string","description":"The country code for the user's phone number."},"number":{"type":"string","description":"The user's phone number without the country code."}},"required":["country_code","number"]},"address":{"type":"object","description":"The user's address details.","example":{"address_line_1":"Calle 1 # 19A - 91","address_line_2":"Casa","address_line_3":"#2","locality":"4","sublocality":"k","administrative_district":"fo","postal_code":"111101","country":"COL"},"properties":{"address_line_1":{"type":"string","description":"Address line 1."},"address_line_2":{"type":"string","description":"Address line 2."},"address_line_3":{"type":"string","description":"Address line 3."},"locality":{"type":"string","description":"Locality of the provided address."},"sublocality":{"type":"string","description":"Sublocality of the provided address."},"administrative_district":{"type":"string","description":"Administrative district of the provided address."},"postal_code":{"type":"string","description":"Postal code of the provided address."},"country":{"type":"string","description":"Country of the provided address."}},"required":["address_line_1","locality","administrative_district","postal_code","country"]},"preferred_language":{"type":"string","description":"The user's preferred language, used for system notifications.","example":"en_US"},"note":{"type":"string","description":"A custom note associated with this end user.","example":"This is a special customer."},"primary_reference":{"type":"string","description":"The End User's primary reference, used to associate the end user with an entity in an external system.","example":"23423524"},"secondary_reference":{"type":"string","description":"The End User's secondary reference, used to associate the end user with an entity in an external system.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object.","example":{"order_id":"6735"}},"creation_source":{"type":"string","description":"The channel through which the end user was created.","example":"API"},"date_created_gmt":{"type":"string","description":"The creation date of the end user in GMT ISO format.","example":"2021-11-15T23:23:38Z"},"date_updated_gmt":{"type":"string","description":"The updated date of the end user in GMT ISO format.","example":"2021-11-15T23:23:38Z"}}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/connect/link/create":{"post":{"operationId":"createConnectLink","summary":"Create Connect Link","description":"Creates a new Connect Link to securely connect an end user's bank account. This endpoint generates a customizable Connect Link object. This link can be sent to customers to safely initiate the account connection process, supporting custom colors, redirection configurations, and language defaults.","tags":["Connect Links"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"intro_text":{"type":"string","description":"The introductory text displayed in the center of the link interface. The text must include both the merchant name (as registered in the business profile) and 'DRUO'. This field has a minimum length of 40 characters and a maximum length of 70 characters.","example":"NOVO uses DRUO to connect to your bank account."},"new_end_user_details":{"type":"object","description":"The customer details for a new end user. This field is required only if existing_end_user_id is not provided.","example":"<new_end_user_details>"},"existing_end_user_id":{"type":"string","description":"The unique identifier of an existing end user. This field is required only if new_end_user_details is not provided.","example":"eur_422f0f81-5001-4cce-a229-242d9ab9960a"},"merchant_id":{"type":"string","description":"The unique identifier of the merchant associated with the connect link.","example":"mer_fe1b01b8-66f9-4bef-be36-5cb2ebacc004"},"background_color":{"type":"string","description":"The HEX color code for the link background.","example":"#333333"},"button_color":{"type":"string","description":"The HEX color code for the link buttons.","example":"#ffffff"},"button_text_color":{"type":"string","description":"The HEX color code for the link button text.","example":"#000000"},"content_box_text_color":{"type":"string","description":"The HEX color code for the text inside the content box.","example":"#333333"},"content_background_color":{"type":"string","description":"The HEX color code for the content box background.","example":"#eaeaea"},"default_institution":{"type":"string","description":"The identifier of the default financial institution to pre-select in the link flow.","example":"ins_e42460a8-c783-4bc3-8dcd-2e6fcab78b77"},"primary_reference":{"type":"string","description":"The primary reference for the connect link. Used to associate the connected account with an entity in an external system.","example":"23423524"},"secondary_reference":{"type":"string","description":"The secondary reference for the connect link. Used to associate the connected account with an entity in an external system.","example":"bj39fhow39fhqp3f0hfae4344"},"default_language":{"type":"string","description":"The language code to display the link flow in. Defaults to English if left blank.","example":"es-co"},"redirect_url":{"type":"string","description":"The URL to redirect to after completing the connection flow. Parameters such as account code (ac), account last 4 (al4), account institution name (ain), account status (as), account UUID (aid), and connect link UUID (clid) will be appended as URL query parameters.","example":"https://example.com"},"expiration_date":{"type":"string","description":"The expiration date and time for the connect link in GMT (ISO 8601 format). If set, users will see an error page if they attempt to open the link after this date.","example":"2021-11-16T23:23:38"},"metadata":{"type":"string","description":"A set of key-value pairs that can be attached to the object. You can specify up to 50 keys, with key names up to 40 characters and values up to 500 characters.","example":{"order_id":"6735","user_id":"1234567","account_id":"09819"}},"custom_confirmation_page":{"type":"boolean","description":"If true, the user is redirected directly to the redirect_url without displaying the DRUO confirmation page.","example":false},"requested_account_capabilities":{"type":"array","description":"Determines which account capabilities are enabled when the link is created.","enum":["PAYMENT","PAYOUT"],"example":["PAYMENT","PAYOUT"],"items":{}}},"required":["intro_text","new_end_user_details","existing_end_user_id"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier of the connect link.","example":"clk_aee571f2-cdf0-4fad-8abb-74fcb8b83f20"},"code":{"type":"string","description":"The unique code of the connect link.","example":"CLR33JXMNXU"},"url":{"type":"string","description":"The secure URL to which the user should be redirected to connect their account.","example":"https://link.druo.com/connect/secure?sl=fd6f7577c"},"expired":{"type":"boolean","description":"Indicates whether the connect link has expired.","example":false},"background_color":{"type":"string","description":"The HEX color code for the link background.","example":"#333333"},"button_color":{"type":"string","description":"The HEX color code for the link buttons.","example":"#ffffff"},"button_text_color":{"type":"string","description":"The HEX color code for the link button text.","example":"#000000"},"content_box_text_color":{"type":"string","description":"The HEX color code for the text inside the content box.","example":"#333333"},"content_background_color":{"type":"string","description":"The HEX color code for the content box background.","example":"#eaeaea"},"intro_text":{"type":"string","description":"The key-value pairs mapping languages to their configured intro text.","example":"en_US: NOVO uses DRUO to connect to your bank account."},"delivery_status":{"type":"string","description":"The current delivery status of the connect link.","example":"CREATED"},"end_user":{"type":"object","description":"The details of the end-user customer associated with this connect link.","example":"<end_user>"},"default_institution":{"type":"string","description":"The pre-selected financial institution for the link.","example":"<default_institution>"},"primary_reference":{"type":"string","description":"The primary reference for the connect link. Used to associate the connected account with an entity in an external system.","example":"23423524"},"secondary_reference":{"type":"string","description":"The secondary reference for the connect link. Used to associate the connected account with an entity in an external system.","example":"bj39fhow39fhqp3f0hfae4344"},"default_language":{"type":"string","description":"The language code configured to display the link in.","enum":["es_CO","en_US"],"example":"<default_language>"},"redirect_url":{"type":"string","description":"The URL to redirect the user to once the flow completes successfully.","example":"https://example.com"},"expiration_date":{"type":"string","description":"The GMT expiration timestamp for the connect link.","example":"2021-11-16T23:23:38"},"custom_confirmation_page":{"type":"boolean","description":"Indicates whether the redirect occurs automatically without showing the DRUO confirmation page.","example":false},"metadata":{"type":"string","description":"Key-value pairs containing custom metadata attached to the object.","example":{"order_id":"6735"}},"date_created_gmt":{"type":"string","description":"The creation timestamp of the connect link in GMT.","example":"2021-11-15T23:23:38Z"},"date_updated_gmt":{"type":"string","description":"The last update timestamp of the connect link in GMT.","example":"2021-11-15T23:23:38Z"}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/connect/link/{connect_link_uuid}":{"get":{"operationId":"getConnectLink","summary":"Get Connect Link","description":"Retrieve the details of an existing Connect Link. Returns the configuration, styling parameters, references, and metadata associated with a specific Connect Link using its unique UUID.","tags":["Connect Links"],"parameters":[{"name":"connect_link_uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier (UUID) of the Connect Link.","example":"clk_aee571f2-cdf0-4fad-8abb-74fcb8b83f20"},"code":{"type":"string","description":"The Connect Link's unique code.","example":"CLR33JXMNXU"},"url":{"type":"string","description":"The URL that the user should be redirected to in order to connect their account.","example":"https://link.druo.com/connect/secure?sl=fd6f7577c"},"expired":{"type":"boolean","description":"Indicates whether the link is expired.","example":false},"background_color":{"type":"string","description":"The HEX code for the link's background color.","example":"#333333"},"button_color":{"type":"string","description":"The HEX code for the link's button color.","example":"#ffffff"},"button_text_color":{"type":"string","description":"The HEX code for the link's button text color.","example":"#000000"},"content_box_text_color":{"type":"string","description":"The HEX code for the content box text color.","example":"#333333"},"content_background_color":{"type":"string","description":"The HEX code for the content background color.","example":"#eaeaea"},"intro_text":{"type":"object","description":"The key-value pairs containing the introductory text localized for each language. The text must include the merchant name (as registered in the business profile) and 'DRUO'.","example":{"en_US":"NOVO uses DRUO to connect to your bank account.","es_CO":"NOVO utiliza a DRUO para conectarse con tu cuenta bancaria."}},"delivery_status":{"type":"string","description":"The delivery status of the Connect Link.","example":"CREATED"},"end_user":{"type":"object","description":"Information about the end-user customer.","example":"<end_user>"},"default_institution":{"type":"string","description":"The default institution identifier for the Connect Link.","example":"<default_institution>"},"primary_reference":{"type":"string","description":"The primary reference of the Connect Link. This can be any value used to associate the connected account with an entity in an external system.","example":"23423524"},"secondary_reference":{"type":"string","description":"The secondary reference of the Connect Link. This can be any value used to associate the connected account with an entity in an external system.","example":"bj39fhow39fhqp3f0hfae4344"},"default_language":{"type":"string","description":"The language code used to display the link. If left blank, the system defaults to English.","enum":["es_CO","en_US"],"example":"<default_language>"},"redirect_url":{"type":"string","description":"The URL to redirect to after the connection flow is completed. Parameters like Reference, Status, and Connected Account Code will be appended as URL query parameters.","example":"https://example.com"},"expiration_date":{"type":"string","description":"The expiration date for this Connect Link in GMT. If set, the user is presented with an error upon opening the link.","example":"2021-11-16T23:23:38"},"custom_confirmation_page":{"type":"boolean","description":"If true, the user is redirected directly to the redirect URL without displaying the default DRUO redirect page.","example":false},"metadata":{"type":"object","description":"A set of key-value pairs that you can attach to the object.","example":{"order_id":"6735"}},"date_created_gmt":{"type":"string","description":"The creation date and time of the account in GMT.","example":"2021-11-15T23:23:38Z"},"date_updated_gmt":{"type":"string","description":"The last update date and time of the account in GMT.","example":"2021-11-15T23:23:38Z"}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/connect/link/list":{"get":{"operationId":"listConnectLinks","summary":"List Connect Links","description":"Retrieve a paginated list of Connect Links. Returns a list of existing Connect Links. This endpoint supports pagination and advanced filtering by parameters such as the Connect Link UUID or the end user's email address.","tags":["Connect Links"],"parameters":[{"name":"uuid","in":"query","required":false,"description":"Filter the list of Connect Links by UUID.","schema":{"type":"string"}},{"name":"end_user_email","in":"query","required":false,"description":"Filter the list of Connect Links by the end user's email address.","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"The page number to return. Starts at 1.","schema":{"type":"integer"}},{"name":"page_size","in":"query","required":false,"description":"The number of items per page. Defaults to 1000 when omitted.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","description":"The Connect Link's UUID.","example":"clk_aee571f2-cdf0-4fad-8abb-74fcb8b83f20"},"code":{"type":"string","description":"The Connect Link's unique code.","example":"CLR33JXMNXU"},"url":{"type":"string","description":"The URL that the user should be redirected to in order to connect their account.","example":"https://link.druo.com/connect/secure?sl=fd6f7577c"},"expired":{"type":"boolean","description":"Indicates whether the Connect Link has expired.","example":false},"background_color":{"type":"string","description":"The HEX color code for the link's background.","example":"#333333"},"button_color":{"type":"string","description":"The HEX color code for the link's button.","example":"#ffffff"},"button_text_color":{"type":"string","description":"The HEX color code for the link's button text.","example":"#000000"},"content_box_text_color":{"type":"string","description":"The HEX color code for the content box text.","example":"#333333"},"content_background_color":{"type":"string","description":"The HEX color code for the content box background.","example":"#eaeaea"},"intro_text":{"type":"object","description":"Localized introductory text mapped by language code. All options must include the registered merchant name and the text 'DRUO'.","example":{"en_US":"NOVO uses DRUO to connect to your bank account.","es_CO":"NOVO utiliza a DRUO para conectarse con tu cuenta bancaria."}},"delivery_status":{"type":"string","description":"The current delivery status of the Connect Link.","example":"CREATED"},"end_user":{"type":"object","description":"Detailed information about the associated end user customer.","example":"<end_user>"},"default_institution":{"type":"string","description":"The default financial institution assigned to the Connect Link.","example":"<default_institution>"},"primary_reference":{"type":"string","description":"The primary reference string used to associate the connected account with an external system entity.","example":"23423524"},"secondary_reference":{"type":"string","description":"The secondary reference string used to associate the connected account with an external system entity.","example":"bj39fhow39fhqp3f0hfae4344"},"default_language":{"type":"string","description":"The language code used to display the link. If left blank, the system defaults to English.","enum":["es_CO","en_US"],"example":"<default_language>"},"redirect_url":{"type":"string","description":"The URL to redirect the user to after completing the connection flow. Parameters such as reference, status, and connected account code will be appended to this URL.","example":"https://example.com"},"expiration_date":{"type":"string","description":"The expiration timestamp for this Connect Link in GMT. If the link is expired when opened, the user will be shown an error page.","example":"2021-11-16T23:23:38"},"custom_confirmation_page":{"type":"boolean","description":"If true, the user is redirected immediately to the redirect URL, bypassing the standard DRUO confirmation page.","example":false},"metadata":{"type":"object","description":"Key-value pairs containing custom metadata attached to the object. Supports up to 50 keys, with key names up to 40 characters and values up to 500 characters.","example":{"order_id":"6735"}},"date_created_gmt":{"type":"string","description":"The creation timestamp of the account in GMT.","example":"2021-11-15T23:23:38Z"},"date_updated_gmt":{"type":"string","description":"The last updated timestamp of the account in GMT.","example":"2021-11-15T23:23:38Z"}}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/connect/link/{connect_link_uuid}/expire":{"put":{"operationId":"expireConnectLink","summary":"Expire Connect Link","description":"Expires an active Connect Link. Sets the 'expired' property of a given Connect Link to true, preventing users from accessing the link.","tags":["Connect Links"],"parameters":[{"name":"connect_link_uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The Connect Link's UUID.","example":"clk_aee571f2-cdf0-4fad-8abb-74fcb8b83f20"},"code":{"type":"string","description":"The Connect Link's code.","example":"CLR33JXMNXU"},"url":{"type":"string","description":"The URL that the user should be sent to to connect their account.","example":"https://link.druo.com/connect/secure?sl=fd6f7577c"},"expired":{"type":"boolean","description":"If true, the link has expired.","example":false},"background_color":{"type":"string","description":"The HEX code for the link's background color.","example":"#333333"},"button_color":{"type":"string","description":"The HEX code for the link's button color.","example":"#ffffff"},"button_text_color":{"type":"string","description":"The HEX code for the link's button text color.","example":"#000000"},"content_box_text_color":{"type":"string","description":"The HEX code for the content box text color.","example":"#333333"},"content_background_color":{"type":"string","description":"The HEX code for the content background text color.","example":"#eaeaea"},"intro_text":{"type":"string","description":"Key-value pairs for the intro text in each language. The text in all options must include the merchant name (as registered in the business profile) as well as 'DRUO'.","example":"en_US: NOVO uses DRUO to connect to your bank account."},"delivery_status":{"type":"string","description":"The Connect Link's delivery status.","example":"CREATED"},"end_user":{"type":"object","description":"Information about the end user.","example":"<end_user>"},"default_institution":{"type":"string","description":"The Connect Link's default institution.","example":"<default_institution>"},"primary_reference":{"type":"string","description":"The Connect Link's primary reference. Can be any value to associate the connected account to an entity in an external system.","example":"23423524"},"secondary_reference":{"type":"string","description":"The Connect Link's secondary reference. Can be any value to associate the connected account to an entity in an external system.","example":"bj39fhow39fhqp3f0hfae4344"},"default_language":{"type":"string","description":"The language code to display this link in. If left blank, the system will default to English.","enum":["es_CO","en_US"],"example":"<default_language>"},"redirect_url":{"type":"string","description":"The URL to redirect to after the connection flow is completed. Reference, Status, and Connected Account Code will be appended as URL parameters.","example":"https://example.com"},"expiration_date":{"type":"string","description":"The expiration date for this Connect Link in GMT time. If set, the user will be presented with an error upon opening the link.","example":"2021-11-16T23:23:38"},"custom_confirmation_page":{"type":"boolean","description":"If true, the user will be taken directly to the redirect URL without showing the DRUO redirect page.","example":false},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long.","example":{"order_id":"6735"}},"date_created_gmt":{"type":"string","description":"The creation date of the account in GMT.","example":"2021-11-15T23:23:38Z"},"date_updated_gmt":{"type":"string","description":"The update date of the account in GMT.","example":"2021-11-15T23:23:38Z"}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/accounts/connect":{"post":{"operationId":"connectAccount","summary":"Connect Account","description":"Submit an account connection request using merchant-provided data to bypass the Connect Link flow. This endpoint directly creates a Connected Account object. It is designed for merchants who gather account details through their own interface and want to bypass the standard DRUO hosted connection flow.","tags":["Accounts"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user_authorization":{"type":"string","description":"Confirmation that the end user has authorized their account to be connected with the DRUO system. Must be TRUE to process the connection.","enum":["TRUE","FALSE"],"example":"TRUE"},"institution_uuid":{"type":"string","description":"The UUID of the institution where the connected account is registered.","example":"ins_ff6c5094-1cd1-11ec-9621-0242ac130002"},"type":{"type":"string","description":"The type of account. Determines whether the account holds value.","example":"DEPOSITORY"},"subtype":{"type":"string","description":"The subtype of the account, providing further detail about the type of account.","example":"SAVINGS"},"account_number":{"type":"integer","description":"The account's number.","example":400326054},"new_end_user_details":{"type":"object","description":"The user information object. This field is required only if existing_end_user_id is empty.","example":"<new_end_user_details>"},"merchant_id":{"type":"string","description":"The unique identifier of the merchant.","example":"mer_fe1b01b8-66f9-4bef-be36-5cb2ebacc004"},"existing_end_user_id":{"type":"string","description":"The unique identifier of the existing end user.","example":"eur_ff6c5094-1cd1-11ec-9621-0242ac130002"},"routing_number":{"type":"integer","description":"The account's routing number, which typically indicates where the account was opened.","example":324937448},"primary_reference":{"type":"string","description":"The primary reference of the account. Can be any value to associate the connected account with an entity in an external system.","example":"23423524"},"secondary_reference":{"type":"string","description":"The secondary reference of the account. Can be any value to associate the connected account with an entity in an external system.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"string","description":"A set of key-value pairs that you can attach to an object. You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long.","example":{"order_id":"6735"}},"alias_network_id":{"type":"string","description":"A valid code within the alias networks table.","example":"Bre-B"},"primary_identifier":{"type":"string","description":"The primary identifier payload, such as a payment key or IBAN.","example":"@brebkey123"},"custom_confirmation_page":{"type":"boolean","description":"If true, the user will be taken directly to the redirect URL without showing the DRUO redirect page.","example":false},"redirect_url":{"type":"string","description":"The URL to redirect to after the connection flow is completed. The parameters 'ac' (account code), 'al4' (last 4 digits), 'ain' (institution name), 'as' (status), 'aid' (account UUID), and 'clid' (link UUID) will be appended as URL query parameters.","example":"https://example.com"}},"required":["user_authorization","institution_uuid","type","subtype","account_number","new_end_user_details"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier of the connected account.","example":"acc_747536f4-1efd-4cad-91b3-cc8aaeed93e3"},"code":{"type":"string","description":"The code or record locator for the connected account.","example":"ACSCDSVFGH"},"source_connect_link":{"type":"string","description":"The UUID of the Connect Link used to connect this account.","example":"clk_422f0f81-5001-4cce-a229-242d9ab9960a"},"current_status":{"type":"string","description":"The current status of this connected account.","example":"CONNECTED"},"requires_account_validation":{"type":"boolean","description":"If true, the account requires validation via the Validate Account endpoint using the slug provided in pending_account_validations.","example":true},"pending_account_validations":{"type":"array","description":"A list of pending account validations required to complete the account connection.","example":[{"id":"1d8584d9-6761-4441-bba1-70713c02c8a8","status":"NEED_AUTHENTICATION","link_url":"link.druo.com/36d345dc-cdb8-4abb-baed-df2a42c8d7b1?sl=b8772a3a-ca25-4fec-a669-adb91d6ee26d-bc4277fa-3d5c-4383-bb50-f044975a66eb"}],"items":{}},"remarks":{"type":"string","description":"The connection status remarks for this connected account.","example":"ACCOUNT_DOES_NOT_EXIST"},"institution":{"type":"object","description":"An object containing the UUID and name of the institution where the connected account is registered.","example":{"uuid":"ins_ff6c5094-1cd1-11ec-9621-0242ac130002","name":"Banco"}},"last_4":{"type":"string","description":"The last four digits of the actual account number.","example":"4524"},"type":{"type":"string","description":"The type of account. Determines whether the account holds value.","example":"DEPOSITORY"},"subtype":{"type":"string","description":"The subtype of the account, providing further detail about its type.","example":"SAVINGS"},"capabilities":{"type":"string","description":"The capabilities enabled for this account.","example":"PAYMENTS, BALANCE, IDENTITY, AUTHENTICATION, TRANSFERS"},"end_user":{"type":"object","description":"The full End User object related to this account.","example":"<end_user>"},"disconnection_reason":{"type":"string","description":"The reason why the account was disconnected.","example":"ACTIVITY_COMPLETED"},"disconnection_note":{"type":"string","description":"Additional notes explaining the account's disconnection.","example":"<disconnection_note>"},"primary_reference":{"type":"string","description":"The primary reference of the account, used to associate it with an entity in an external system.","example":"23423524"},"secondary_reference":{"type":"string","description":"The secondary reference of the account, used to associate it with an entity in an external system.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"string","description":"A set of key-value pairs attached to the account object.","example":{"order_id":"6735"}},"creation_source":{"type":"string","description":"The source that initiated the creation of the account.","example":"MERCHANT_API"},"date_created_gmt":{"type":"string","description":"The date and time the account was created in GMT format.","example":"2021-11-15T23:23:38Z"},"date_updated_gmt":{"type":"string","description":"The date and time the account was last updated in GMT format.","example":"2021-11-15T23:23:38Z"}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/accounts/validate":{"post":{"operationId":"validateAccount","summary":"Validate Account","description":"Submits an account validation request and creates a validated Account object. This endpoint validates account details provided by the merchant and registers the account in the DRUO system. It can associate the account with either a new end user or an existing end user ID.","tags":["Accounts"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user_authorization":{"type":"string","description":"Confirmation that the End User has authorized their account to be validated with the DRUO system. Must be TRUE to process account validation.","enum":["TRUE","FALSE"],"example":"TRUE"},"institution_uuid":{"type":"string","description":"The UUID of the Institution where the Account is registered.","example":"ins_ff6c5094-1cd1-11ec-9621-0242ac130002"},"type":{"type":"string","description":"The type of account. Determines whether the account holds value.","example":"DEPOSITORY"},"subtype":{"type":"string","description":"The subtype of account. Provides further detail about the type of account.","example":"SAVINGS"},"account_number":{"type":"integer","description":"The account's number.","example":400326054},"new_end_user_details":{"type":"object","description":"The new user's details. This field is required only if existing_end_user_id is empty.","example":"<new_end_user_details>"},"existing_end_user_id":{"type":"string","description":"The ID of an existing end user.","example":"eur_ff6c5094-1cd1-11ec-9621-0242ac130002"},"routing_number":{"type":"integer","description":"The account's routing number (usually indicates where the account was opened).","example":324937448},"primary_reference":{"type":"string","description":"The primary reference to associate the account with an entity in an external system.","example":"23423524"},"secondary_reference":{"type":"string","description":"The secondary reference to associate the account with an entity in an external system.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long.","example":{"order_id":"6735"}}},"required":["user_authorization","institution_uuid","type","subtype","account_number","new_end_user_details"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The Account's UUID.","example":"acc_747536f4-1efd-4cad-91b3-cc8aaeed93e3"},"code":{"type":"string","description":"The Account's code.","example":"ACSCDSVFGH"},"source_connect_link":{"type":"string","description":"The Connect Link used to validate this account.","example":"clk_422f0f81-5001-4cce-a229-242d9ab9960a"},"current_status":{"type":"string","description":"The current status of this validated account.","example":"VALIDATION_PENDING"},"requires_account_validation":{"type":"string","description":"If true, use the Validate Account endpoint with the slug of pending_account_validations.","enum":["TRUE","FALSE"],"example":"<requires_account_validation>"},"pending_account_validations":{"type":"array","description":"A list of pending account authorizations to validate this account. If this field is present, use the Authorize Account endpoint with the slug value.","example":[{"slug":"b8772a3a-ca25-4fec-a669-adb91d6ee26d-bc4277fa-3d5c-4383-bb50-f044975a66eb","action":"CONFIRM_REQUEST_WITH_INSTITUTION"}],"items":{}},"remarks":{"type":"string","description":"Remarks concerning this account validation.","example":"ACCOUNT_DOES_NOT_EXIST"},"institution":{"type":"object","description":"Object containing the UUID and name of the institution where the account is registered.","example":{"uuid":"ins_ff6c5094-1cd1-11ec-9621-0242ac130002","name":"Banco"}},"last_4":{"type":"string","description":"The last 4 digits of the actual account number.","example":"4524"},"type":{"type":"string","description":"The type of account. Determines whether the account holds value.","example":"DEPOSITORY"},"subtype":{"type":"string","description":"The subtype of account. Provides further detail about the type of account.","example":"SAVINGS"},"capabilities":{"type":"string","description":"The capabilities available for this account.","example":"PAYMENTS, BALANCE, IDENTITY, AUTHENTICATION, TRANSFERS"},"end_user":{"type":"object","description":"The full End User object related to this Account.","example":"<end_user>"},"disconnection_reason":{"type":"string","description":"The account's disconnection reason.","example":"ACTIVITY_COMPLETED"},"disconnection_note":{"type":"string","description":"The account's disconnection note.","example":"<disconnection_note>"},"primary_reference":{"type":"string","description":"The primary reference to associate the account with an entity in an external system.","example":"23423524"},"secondary_reference":{"type":"string","description":"The secondary reference to associate the account with an entity in an external system.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object.","example":{"order_id":"6735"}},"creation_source":{"type":"string","description":"The creation source for this account.","example":"MERCHANT_API"},"date_created_gmt":{"type":"string","description":"Creation date and time of the account in GMT.","example":"2021-11-15T23:23:38Z"},"date_updated_gmt":{"type":"string","description":"Last update date and time of the account in GMT.","example":"2021-11-15T23:23:38Z"}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/accounts/authenticate":{"put":{"operationId":"authenticateAccount","summary":"Authenticate Account","description":"Authenticate a pending bank account validation request. Submits the authentication credentials, such as a one-time password (OTP), required to verify ownership of a pending account.","tags":["Accounts"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_uuid":{"type":"string","description":"The unique identifier (UUID) of the account being validated.","example":"acc_ff6c5094-1cd1-11ec-9621-0242ac130002"},"slug":{"type":"string","description":"The unique validation slug associated with the pending account authentication.","example":"018addfb-cf77-48db-9884-f6b036a3e278-e775cf1e-7986-4691-946a-136179fecc0"},"otp":{"type":"string","description":"The one-time password (OTP) received by the user on their device. This field is conditionally required if the pending account validation action is 'CONFIRM_OTP_VIA_MICRODEPOSIT'.","example":"72"}},"required":["account_uuid","slug","otp"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"The current verification status of the account validation.","example":"VERIFICATION_IN_PROGRESS"},"action":{"type":"string","description":"The next action required to be performed by the user to progress validation.","example":"CONFIRM_REQUEST_WITH_INSTITUTION"},"remarks":{"type":"string","description":"Additional context or remarks regarding the account validation status.","example":"ACCOUNT_DOES_NOT_EXIST"}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/accounts/{account_uuid}":{"get":{"operationId":"getAccount","summary":"Get Account","description":"Retrieve details of an existing connected account. Returns the configuration, status, capabilities, and associated end user details for a specified account using its unique identifier.","tags":["Accounts"],"parameters":[{"name":"account_uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier of the connected account.","example":"acc_747536f4-1efd-4cad-91b3-cc8aaeed93e3"},"code":{"type":"string","description":"The code associated with the connected account.","example":"ACSCDSVFGH"},"source_connect_link":{"type":"string","description":"The unique identifier of the connect link used to establish this account connection.","example":"clk_422f0f81-5001-4cce-a229-242d9ab9960a"},"current_status":{"type":"string","description":"The current connection status of the account.","example":"CONNECTED"},"requires_account_validation":{"type":"boolean","description":"Indicates whether the account requires verification. If true, use the Validate Account endpoint with the pending validation slug.","example":true},"pending_account_validations":{"type":"array","description":"A list of pending validations required to finalize the account connection.","example":[{"slug":"b8772a3a-ca25-4cde-8ef3-f044975a66eb","action":"CONFIRM_REQUEST_WITH_INSTITUTION"}],"items":{}},"remarks":{"type":"string","description":"Additional remarks regarding the connected account's status.","example":"ACCOUNT_DOES_NOT_EXIST"},"institution":{"type":"object","description":"The financial institution where the account is registered.","example":{"uuid":"ins_ff6c5094-1cd1-11ec-9621-0242ac130002","name":"Banco"}},"last_4":{"type":"string","description":"The last four digits of the financial account number.","example":"4524"},"type":{"type":"string","description":"The type of the account, which determines if the account holds value.","example":"DEPOSITORY"},"subtype":{"type":"string","description":"The subtype of the account, providing further categorization.","example":"SAVINGS"},"capabilities":{"type":"string","description":"A comma-separated list of capabilities enabled for this account.","example":"PAYMENTS, BALANCE, IDENTITY, AUTHENTICATION, TRANSFERS"},"enabled_real_time_payouts":{"type":"boolean","description":"Indicates whether the account is configured for real-time payouts.","example":false},"end_user":{"type":"object","description":"The details of the end user associated with this account.","example":"<end_user>"},"disconnect_reason":{"type":"string","description":"The reason why the account was disconnected.","example":"ACTIVITY_COMPLETED"},"disconnection_note":{"type":"string","description":"An optional note detailing the disconnection.","example":"No longer available"},"primary_reference":{"type":"string","description":"An optional primary reference to associate the connected account with an external system entity.","example":"23423524"},"secondary_reference":{"type":"string","description":"An optional secondary reference to associate the connected account with an external system entity.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"object","description":"A set of key-value pairs for attaching custom metadata to the object.","example":{"order_id":"6735"}},"creation_source":{"type":"string","description":"The system or method that initiated the creation of the account record.","example":"MERCHANT_API"},"date_created_gmt":{"type":"string","description":"The creation timestamp of the account record in GMT.","example":"2021-11-15T23:23:38Z"},"date_updated_gmt":{"type":"string","description":"The last update timestamp of the account record in GMT.","example":"2021-11-15T23:23:38Z"}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/accounts/list":{"get":{"operationId":"listAccounts","summary":"List Accounts","description":"Retrieve a list of accounts associated with a business. This endpoint supports advanced filtering and search capabilities based on the provided query parameters, as well as pagination to manage lists of connected accounts.","tags":["Accounts"],"parameters":[{"name":"uuid","in":"query","required":false,"description":"Filter by the unique identifier of the Connected Account.","schema":{"type":"string"}},{"name":"end_user_email","in":"query","required":false,"description":"Filter by the email of the associated End User.","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"The page number to return. Starts at 1.","schema":{"type":"integer"}},{"name":"page_size","in":"query","required":false,"description":"The number of items per page. Defaults to 1000 when omitted.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","description":"The Connected Account's unique identifier.","example":"acc_747536f4-1efd-4cad-91b3-cc8aaeed93e3"},"code":{"type":"string","description":"The Connected Account's code.","example":"ACSCDSVFGH"},"source_connect_link":{"type":"string","description":"The Connect Link used to connect this account.","example":"clk_422f0f81-5001-4cce-a229-242d9ab9960a"},"current_status":{"type":"string","description":"The current status of the Connected Account.","example":"CONNECTED"},"requires_account_validation":{"type":"boolean","description":"Indicates whether the account requires validation. If true, use the Validate Account endpoint with the value in pending_account_validations.","example":false},"pending_account_validations":{"type":"array","description":"List of pending account validations required to connect this account. If present, use the Validate Account endpoint with the corresponding slug.","example":[{"slug":"b8772a3a-ca25-4c01-8317-f044975a66eb","action":"CONFIRM_REQUEST_WITH_INSTITUTION"}],"items":{}},"remarks":{"type":"string","description":"Account remarks regarding the Connected Account's status.","example":"ACCOUNT_DOES_NOT_EXIST"},"institution":{"type":"object","description":"Contains the unique identifier and name of the financial institution where the Connected Account is registered.","example":{"uuid":"ins_ff6c5094-1cd1-11ec-9621-0242ac130002","name":"Banco"}},"last_4":{"type":"string","description":"The last four digits of the actual account number.","example":"4524"},"type":{"type":"string","description":"The type of account, which determines whether the account holds value.","example":"DEPOSITORY"},"subtype":{"type":"string","description":"The subtype of account, providing further details about the account type.","example":"SAVINGS"},"capabilities":{"type":"string","description":"The capabilities available for this account, returned as a comma-separated list.","example":"PAYMENTS, BALANCE, IDENTITY, AUTHENTICATION, TRANSFERS"},"enabled_real_time_payouts":{"type":"boolean","description":"Indicates whether the account is configured for real-time payouts.","example":false},"end_user":{"type":"object","description":"The complete End User object associated with this account.","example":"<end_user>"},"disconnect_reason":{"type":"string","description":"The reason why the account was disconnected.","example":"ACTIVITY_COMPLETED"},"disconnection_note":{"type":"string","description":"An optional note detailing the disconnection.","example":"No longer available"},"primary_reference":{"type":"string","description":"The Connect Link's primary reference. Can be any external system value.","example":"23423524"},"secondary_reference":{"type":"string","description":"The Connect Link's secondary reference. Can be any external system value.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"object","description":"Set of key-value pairs (up to 50 keys, names up to 40 characters, values up to 500 characters) that you can attach to the object.","example":{"order_id":"6735"}},"creation_source":{"type":"string","description":"The creation source for this account.","example":"MERCHANT_API"},"date_created_gmt":{"type":"string","description":"The date and time when the account was created, in ISO 8601 UTC format.","example":"2021-11-15T23:23:38Z"},"date_updated_gmt":{"type":"string","description":"The date and time when the account was last updated, in ISO 8601 UTC format.","example":"2021-11-15T23:23:38Z"}}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/accounts/{account_uuid}/disconnect":{"put":{"operationId":"disconnectAccount","summary":"Disconnect Account","description":"Disconnects an Account from a Merchant. Disconnects an Account object from a Merchant while providing a disconnection reason and an optional note.","tags":["Accounts"],"parameters":[{"name":"account_uuid","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"disconnection_reason":{"type":"string","description":"The reason why the account is being disconnected.","example":"ACTIVITY_COMPLETED"},"disconnection_note":{"type":"string","description":"An optional note providing additional details about the disconnection.","example":"Account is not valid"}},"required":["disconnection_reason"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier (UUID) of the connected account.","example":"acc_747536f4-1efd-4cad-91b3-cc8aaeed93e3"},"code":{"type":"string","description":"The connected account's unique code.","example":"ACSCDSVFGH"},"source_connect_link":{"type":"string","description":"The Connect Link UUID used to connect this account.","example":"clk_422f0f81-5001-4cce-a229-242d9ab9960a"},"current_status":{"type":"string","description":"The current connection status of the account.","example":"CONNECTED"},"requires_account_validation":{"type":"boolean","description":"Indicates whether this account requires validation. If true, use the Validate Account endpoint.","example":false},"pending_account_validations":{"type":"array","description":"A list of pending account validations required to complete the connection.","example":[{"slug":"b8772a3a-ca25-4fec-a669-adb91d6ee26d-bc4277fa-3d5c-4383-bb50-f044975a66eb","action":"CONFIRM_REQUEST_WITH_INSTITUTION"}],"items":{}},"remarks":{"type":"string","description":"Remarks or error details for this connected account.","example":"ACCOUNT_DOES_NOT_EXIST"},"institution":{"type":"object","description":"Object containing the details of the financial institution where the account is registered.","example":{"uuid":"ins_ff6c5094-1cd1-11ec-9621-0242ac130002","name":"Banco"}},"last_4":{"type":"string","description":"The last four digits of the actual account number.","example":"4524"},"type":{"type":"string","description":"The type of account, which determines whether the account holds store value.","example":"DEPOSITORY"},"subtype":{"type":"string","description":"The subtype of the account, providing further detail about the account type.","example":"SAVINGS"},"capabilities":{"type":"string","description":"A comma-separated list of capabilities supported by this account.","example":"PAYMENTS, BALANCE, IDENTITY, AUTHENTICATION, TRANSFERS"},"end_user":{"type":"object","description":"The end user details associated with this account.","example":"<end_user>"},"disconnection_reason":{"type":"string","description":"The reason why the account was disconnected.","example":"ACTIVITY_COMPLETED"},"disconnection_note":{"type":"string","description":"An optional note describing the disconnection.","example":"<disconnection_note>"},"primary_reference":{"type":"string","description":"The primary reference string used to associate the account with an external system entity.","example":"23423524"},"secondary_reference":{"type":"string","description":"The secondary reference string used to associate the account with an external system entity.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"object","description":"Key-value pairs containing custom metadata attached to the object.","example":{"order_id":"6735"}},"creation_source":{"type":"string","description":"The creation source for this account.","example":"MERCHANT_API"},"date_created_gmt":{"type":"string","description":"The creation date and time of the account in GMT.","example":"2021-11-15T23:23:38Z"},"date_updated_gmt":{"type":"string","description":"The update date and time of the account in GMT.","example":"2021-11-15T23:23:38Z"}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/checkout/link/create":{"post":{"operationId":"createCheckoutLink","summary":"Create Checkout Link","description":"Creates a checkout link for an end user to initiate a payment flow. This endpoint generates a customizable Checkout Link. You can either pass an existing end user ID or provide details to create a new one, configure branding parameters (colors, names, descriptions), and define redirection and reference details for the transaction flow.","tags":["Checkout Links"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"existing_end_user_id":{"type":"string","description":"The unique ID of an existing end user. If not provided, you must populate the new_end_user_details field.","example":"eur_422f0f81-5001-4cce-a229-242d9ab9960a"},"new_end_user_details":{"type":"object","description":"The details for creating a new end user. This field is required if existing_end_user_id is empty.","example":"<new_end_user_details>"},"link_name":{"type":"string","description":"The name of this checkout link.","example":"Default checkout"},"transaction":{"type":"object","description":"The payment transaction information.","example":"<transaction>"},"merchant_id":{"type":"string","description":"The unique identifier of the merchant associated with this checkout link.","example":"mer_fe1b01b8-66f9-4bef-be36-5cb2ebacc004"},"link_description":{"type":"string","description":"The description for this checkout link.","example":"Checkout for Order #3553432"},"background_color":{"type":"string","description":"The HEX code for the link's verification flow background color. Defaults to #ffffff if left empty.","example":"#ffffff"},"sidebar_background_color":{"type":"string","description":"The HEX code for the link's transaction details background color. Defaults to #f2f2f2 if left empty.","example":"#f2f2f2"},"sidebar_text_color":{"type":"string","description":"The HEX code for the link's transaction details text color. Defaults to #333333 if left empty.","example":"#222222"},"text_color":{"type":"string","description":"The HEX code for the link's verification flow text color. Defaults to #333333 if left empty.","example":"#333333"},"button_color":{"type":"string","description":"The HEX code for the link's button color.","example":"#ffffff"},"button_text_color":{"type":"string","description":"The HEX code for the link's button text color.","example":"#000000"},"default_institution":{"type":"string","description":"The default institution used for the checkout link.","example":"ins_e42460a8-c783-4bc3-8dcd-2e6fcab78b77"},"primary_reference":{"type":"string","description":"The primary reference of the checkout link. Can be any value used to associate the connected account to an entity in an external system.","example":"23423524"},"secondary_reference":{"type":"string","description":"The secondary reference of the checkout link. Can be any value used to associate the connected account to an entity in an external system.","example":"bj39fhow39fhqp3f0hfae4344"},"default_language":{"type":"string","description":"The language code to display the link in. Defaults to English if left blank.","example":"es-co"},"redirect_url":{"type":"string","description":"The URL to redirect the user to after the checkout flow is successfully completed.","example":"https://example.com"},"expiration_date":{"type":"string","description":"The expiration date for this checkout link in GMT (ISO 8601 format). If set and expired, the user will be presented with an error upon opening the link.","example":"2021-11-16T23:23:38"},"metadata":{"type":"string","description":"A set of key-value pairs that you can attach to the object. You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long.","example":{"order_id":"6735","user_id":"1234567","account_id":"09819"}},"custom_confirmation_page":{"type":"boolean","description":"If true, the user is redirected directly to the redirect URL without showing the default DRUO confirmation screen.","example":false}},"required":["existing_end_user_id","link_name","transaction"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique UUID of the checkout link.","example":"clk_422f0f81-5001-4cce-a229-242d9ab9960a"},"code":{"type":"string","description":"The unique alphanumeric code of the checkout link.","example":"CSFM03FNA3"},"url":{"type":"string","description":"The checkout URL where the user should be redirected to complete their transaction.","example":"https://link.druo.com/checkout/?sl=e4243523423423423423"},"delivary_status":{"type":"string","description":"The delivery status of the link.","example":"OPENNED"},"link_name":{"type":"string","description":"The name of the checkout link.","example":"Default checkout"},"link_description":{"type":"string","description":"The description of the checkout link.","example":"Checkout for Order #3553432"},"background_color":{"type":"string","description":"The HEX code for the link's verification flow background color.","example":"#ffffff"},"sidebar_background_color":{"type":"string","description":"The HEX code for the link's transaction details background color.","example":"#f2f2f2"},"sidebar_text_color":{"type":"string","description":"The HEX code for the link's transaction details text color.","example":"#222222"},"main_content_box_text_color":{"type":"string","description":"The HEX code for the link's verification flow text color.","example":"#333333"},"button_color":{"type":"string","description":"The HEX code for the link's button color.","example":"#ffffff"},"button_text_color":{"type":"string","description":"The HEX code for the link's button text color.","example":"#000000"},"end_user":{"type":"object","description":"The end user details associated with this checkout link.","example":"<end_user>"},"transaction":{"type":"object","description":"The transaction details associated with this checkout link.","example":"<transaction>"},"default_institution":{"type":"string","description":"The default institution associated with the checkout link.","example":"<default_institution>"},"primary_reference":{"type":"string","description":"The primary reference of the checkout link.","example":"23423524"},"secondary_reference":{"type":"string","description":"The secondary reference of the checkout link.","example":"bj39fhow39fhqp3f0hfae4344"},"default_language":{"type":"string","description":"The language code used to display this link. If left blank, defaults to English.","enum":["es_CO","en_US"],"example":"es_CO"},"redirect_url":{"type":"string","description":"The URL to redirect the user to after the checkout flow is completed. Parameters such as code, reference, and status will be appended to this URL.","example":"https://example.com"},"expiration_date":{"type":"string","description":"The expiration date for this checkout link in GMT.","example":"2021-11-16T23:23:38"},"expired":{"type":"boolean","description":"Indicates whether the link is expired.","example":false},"custom_confirmation_page":{"type":"boolean","description":"If true, the user is redirected directly to the redirect URL without showing the DRUO confirmation page.","example":false},"metadata":{"type":"string","description":"A set of key-value pairs attached to the object.","example":{"order_id":"6735"}},"date_created_gmt":{"type":"string","description":"The creation date of the checkout link in GMT.","example":"2021-11-15T23:23:38Z"},"date_updated_gmt":{"type":"string","description":"The last update date of the checkout link in GMT.","example":"2021-11-15T23:23:38Z"}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/checkout/link/{checkout_link_uuid}":{"get":{"operationId":"getCheckoutLink","summary":"Get Checkout Link","description":"Retrieve the details of an existing checkout link. Returns the configuration, styling, metadata, and status of a specific checkout link using its unique identifier.","tags":["Checkout Links"],"parameters":[{"name":"checkout_link_uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The checkout link's unique identifier (UUID).","example":"clk_422f0f81-5001-4cce-a229-242d9ab9960a"},"code":{"type":"string","description":"The checkout link's code.","example":"CSFM03FNA3"},"url":{"type":"string","description":"The URL that the user should be redirected to in order to complete the checkout.","example":"https://link.druo.com/checkout/?sl=e4243523423423423423"},"delivary_status":{"type":"string","description":"The delivery status of the checkout link.","example":"OPENNED"},"link_name":{"type":"string","description":"The name of this checkout link.","example":"Default checkout"},"link_description":{"type":"string","description":"The description for this checkout link.","example":"Checkout for Order #3553432"},"background_color":{"type":"string","description":"The HEX code for the link's background color.","example":"#333333"},"sidebar_background_color":{"type":"string","description":"The HEX code for the link's transaction details background color. If empty, defaults to #f2f2f2.","example":"#f2f2f2"},"sidebar_text_color":{"type":"string","description":"The HEX code for the link's transaction details text color. If empty, defaults to #333333.","example":"#222222"},"main_content_box_background_color":{"type":"string","description":"The HEX code for the link's verification flow background color. If empty, defaults to #ffffff.","example":"#ffffff"},"main_content_box_text_color":{"type":"string","description":"The HEX code for the link's verification flow text color. If empty, defaults to #333333.","example":"#333333"},"button_color":{"type":"string","description":"The HEX code for the link's button color.","example":"#ffffff"},"button_text_color":{"type":"string","description":"The HEX code for the link's button text color.","example":"#000000"},"end_user":{"type":"object","description":"Information about the end user customer.","example":"<end_user>"},"transaction":{"type":"object","description":"Transaction payment details.","example":"<transaction>"},"default_institution":{"type":"string","description":"The checkout link's default institution.","example":"<default_institution>"},"primary_reference":{"type":"string","description":"The checkout link's primary reference. Used to associate the session with an entity in an external system.","example":"23423524"},"secondary_reference":{"type":"string","description":"The checkout link's secondary reference. Used to associate the session with an entity in an external system.","example":"bj39fhow39fhqp3f0hfae4344"},"default_language":{"type":"string","description":"The language code to display this link in. If left blank, the system defaults to English.","enum":["es_CO","en_US"],"example":"<default_language>"},"redirect_url":{"type":"string","description":"The URL to redirect to after the checkout flow is completed. Reference, Status, and Connected Account Code parameters will be appended.","example":"https://example.com"},"expiration_date":{"type":"string","description":"The expiration date for this checkout link in GMT. If set, opening an expired link presents an error.","example":"2021-11-16T23:23:38"},"expired":{"type":"boolean","description":"Indicates whether the checkout link has expired.","example":false},"custom_confirmation_page":{"type":"boolean","description":"If true, the user is redirected immediately without showing the DRUO confirmation page.","example":false},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object.","example":{"order_id":"6735"}},"date_created_gmt":{"type":"string","description":"The creation date of the checkout link in GMT.","example":"2021-11-15T23:23:38Z"},"date_updated_gmt":{"type":"string","description":"The last updated date of the checkout link in GMT.","example":"2021-11-15T23:23:38Z"}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/checkout/link/list":{"get":{"operationId":"listCheckoutLinks","summary":"List Checkout Links","description":"Retrieve a paginated list of Checkout Links. This endpoint supports filtering and searching for existing Checkout Links based on query parameters such as UUID and end-user email.","tags":["Checkout Links"],"parameters":[{"name":"uuid","in":"query","required":false,"description":"Filter results by the Checkout Link's unique identifier (UUID).","schema":{"type":"string"}},{"name":"end_user_email","in":"query","required":false,"description":"Filter results by the email address of the associated end user.","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"The page number to return. Starts at 1.","schema":{"type":"integer"}},{"name":"page_size","in":"query","required":false,"description":"The number of items per page. Defaults to 1000 when omitted.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","description":"The Checkout Link's UUID.","example":"clk_422f0f81-5001-4cce-a229-242d9ab9960a"},"code":{"type":"string","description":"The Checkout Link's code.","example":"CSFM03FNA3"},"url":{"type":"string","description":"The URL to redirect the user to in order to complete the checkout flow.","example":"https://link.druo.com/checkout/?sl=e4243523423423423423"},"delivary_status":{"type":"string","description":"The delivery status of the Checkout Link.","example":"OPENNED"},"link_name":{"type":"string","description":"The name of this Checkout Link.","example":"Default checkout"},"link_description":{"type":"string","description":"The description for this Checkout Link.","example":"Checkout for Order #3553432"},"background_color":{"type":"string","description":"The HEX code for the link's background color.","example":"#333333"},"sidebar_background_color":{"type":"string","description":"The HEX code for the link's transaction details background color. If empty, defaults to #f2f2f2.","example":"#f2f2f2"},"sidebar_text_color":{"type":"string","description":"The HEX code for the link's transaction details text color. If empty, defaults to #333333.","example":"#222222"},"main_content_box_background_color":{"type":"string","description":"The HEX code for the link's verification flow background color. If empty, defaults to #ffffff.","example":"#ffffff"},"main_content_box_text_color":{"type":"string","description":"The HEX code for the link's verification flow text color. If empty, defaults to #333333.","example":"#333333"},"button_color":{"type":"string","description":"The HEX code for the link's button color.","example":"#ffffff"},"button_text_color":{"type":"string","description":"The HEX code for the link's button text color.","example":"#000000"},"end_user":{"type":"object","description":"Information about the end user customer.","example":"<end_user>"},"transaction":{"type":"object","description":"Details of the associated payment transaction.","example":"<transaction>"},"default_institution":{"type":"string","description":"The Checkout Link's default financial institution.","example":"<default_institution>"},"primary_reference":{"type":"string","description":"The Checkout Link's primary reference. Used to associate the checkout flow with an entity in an external system.","example":"23423524"},"secondary_reference":{"type":"string","description":"The Checkout Link's secondary reference. Used to associate the checkout flow with an entity in an external system.","example":"bj39fhow39fhqp3f0hfae4344"},"default_language":{"type":"string","description":"The language code in which to display the link. If left blank, the system defaults to English.","enum":["es_CO","en_US"],"example":"<default_language>"},"redirect_url":{"type":"string","description":"The URL to redirect to after the connection flow is completed. Reference, Status, and Connected Account Code will be appended as URL parameters.","example":"https://example.com"},"expiration_date":{"type":"string","description":"The expiration date for this Checkout Link in GMT. If the link is accessed after this date, an error is displayed.","example":"2021-11-16T23:23:38"},"expired":{"type":"boolean","description":"Indicates whether the Checkout Link has expired.","example":false},"custom_confirmation_page":{"type":"boolean","description":"If true, the user is taken directly to the redirect URL without showing the default DRUO redirect page.","example":false},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long.","example":{"order_id":"6735"}},"date_created_gmt":{"type":"string","description":"The creation date of the checkout link in GMT.","example":"2021-11-15T23:23:38Z"},"date_updated_gmt":{"type":"string","description":"The last updated date of the checkout link in GMT.","example":"2021-11-15T23:23:38Z"}}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/payments/create":{"post":{"operationId":"createPayment","summary":"Create Payment","description":"Creates a payment request and initiates a transaction. This endpoint creates a Transaction object to process a payment. It supports split payments through the additional recipients parameter and allows scheduling for future processing.","tags":["Payments"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tenant_id":{"type":"string","description":"The ID of the tenant that originated the transaction.","example":"ten_0521aadc-5fbd-4b3c-af0a-a4f4b8d6f20a"},"amount":{"type":"integer","description":"The amount of money in the smallest denomination of the currency (e.g., cents for USD). For example, $10.00 USD is represented as 1000.","example":10000},"description":{"type":"string","description":"A description of the transaction, which may be visible to users in email receipts.","example":"Insurance policy renewal - INV12324"},"auto_send_receipt":{"type":"boolean","description":"If set to true, the system will automatically generate and send a receipt using the preferred delivery method.","example":false},"funding_source_id":{"type":"string","description":"The ID of the account used to fund this transaction.","example":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"},"statement_descriptor":{"type":"string","description":"The description reported to financial institutions to appear on your customers' bank statements. Must contain at least one letter and be between 4 and 22 characters. This request may or may not be honored by the institution.","example":"NOVO BILLING* INV12324"},"merchant_id":{"type":"string","description":"The ID of the merchant or sub-merchant to associate with this transaction.","example":"mer_fe1b01b8-66f9-4bef-be36-5cb2ebacc004"},"retry_sequence_id":{"type":"string","description":"The ID of the smart retry sequence to associate with this transaction.","example":"rsq_344da259-fb89-405e-a353-2491ca840001"},"currency":{"type":"string","description":"The currency code in ISO 4217 format (e.g., USD).","example":"USD"},"primary_reference":{"type":"string","description":"An optional primary ID to associate with the transaction for your own database mapping. Maximum 40 characters.","example":"ABC123"},"secondary_reference":{"type":"string","description":"An optional secondary ID to associate with the transaction for your own database mapping. Maximum 40 characters.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"object","description":"A set of up to 50 key-value pairs that you can attach to the object. Key names can be up to 40 characters and values up to 500 characters.","example":{"order_id":"6735"}},"additional_recipients":{"type":"array","description":"An array of objects specifying split payment details among multiple merchants.","example":[{"merchant_uuid":"mer_d2d6b689-ed2b-4a5d-9f09-239c5c98b241","amount":"10%","description":"Payout split by percentage","primary_reference":"0000000000001","secondary_reference":"AAAAAAAA001"}],"items":{}},"due_date":{"type":"string","description":"The date on which this transaction will be processed. Must be a future date in YYYY-MM-DD format.","example":"2021-11-15"}},"required":["tenant_id","amount","description","auto_send_receipt","funding_source_id","statement_descriptor"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The transaction's unique UUID.","example":"trx_422f0f81-5001-4cce-a229-242d9ab9960a"},"code":{"type":"string","description":"The transaction's short reference code.","example":"TXNMW9PCWE"},"status":{"type":"string","description":"The current status of the transaction.","enum":["CREATED","PENDING","PROCESSING","SUCCESSFUL","REFUNDED","DISPUTED","FAILED","CANCELED","REVERSED"],"example":"SUCCESSFUL"},"tenant":{"type":"object","description":"The details of the tenant that originated the transaction.","example":{"uuid":"ten_0521aadc-5fbd-4b3c-af0a-a4f4b8d6f20"}},"type":{"type":"string","description":"The transaction type.","example":"PAYMENT"},"creation_source":{"type":"string","description":"The source platform where the transaction was created.","example":"MERCHANT_PORTAL"},"amount":{"type":"integer","description":"The transaction amount in the smallest currency denomination.","example":10000},"variable_fee":{"type":"integer","description":"The variable fee amount charged for this transaction.","example":300},"fixed_fee":{"type":"integer","description":"The fixed fee amount charged for this transaction.","example":100},"total_fee":{"type":"integer","description":"The total fee amount charged for this transaction.","example":400},"net_amount":{"type":"integer","description":"The total net amount to be paid (amount minus total_fee).","example":9600},"currency":{"type":"object","description":"The currency details of the transaction.","example":{"code":"USD"}},"description":{"type":"string","description":"The description of this transaction.","example":"Insurance policy renewal - INV12324"},"remarks":{"type":"string","description":"Additional internal remarks or context about the transaction status.","example":"REQUESTED_BY_MERCHANT"},"funding_source":{"type":"object","description":"The funding source account details.","example":{"uuid":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"}},"statement_descriptor":{"type":"string","description":"The descriptor that appears on bank statements.","example":"NOVO BILLING* INV12324"},"primary_reference":{"type":"string","description":"The primary database reference ID associated with the transaction.","example":"ABC123"},"secondary_reference":{"type":"string","description":"The secondary database reference ID associated with the transaction.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"object","description":"Custom metadata key-value pairs associated with the transaction.","example":{"order_id":"6735"}},"decline_reason":{"type":"string","description":"The reason the transaction was declined, if applicable.","example":"INSUFFICIENT_FUNDS"},"auto_send_receipt":{"type":"boolean","description":"Indicates whether a transaction receipt will be automatically sent.","example":false},"due_date":{"type":"string","description":"The scheduled date on which this transaction will be processed.","example":"2021-11-15"},"date_created_gmt":{"type":"string","description":"The timestamp when the transaction was created, in GMT.","example":"2021-11-15T23:23:38"},"date_updated_gmt":{"type":"string","description":"The timestamp when the transaction was last updated, in GMT.","example":"2021-11-15T23:23:38"},"additional_recipients":{"type":"array","description":"The transactional detailed breakdown of corresponding split payments created for additional recipients.","example":[{"tenant_id":"ten_35516d40-ca41-4fa3-885c-d13d0ccdae0a","amount":20000,"description":"Remaining transaction for original merchant.","uuid":"trx_75a53949-edee-408c-8599-8e1bcd23211b","net_amount":3100,"total_fee":400,"fixed_fee":0,"variable_fee":400}],"items":{}}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/payments/{transaction_uuid}":{"get":{"operationId":"getPayment","summary":"Get Payment","description":"Retrieve the details of an existing payment. Retrieves the full transaction details for a specific payment using its unique transaction UUID.","tags":["Payments"],"parameters":[{"name":"transaction_uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The transaction's unique UUID.","example":"trx_422f0f81-5001-4cce-a229-242d9ab9960a"},"code":{"type":"string","description":"The transaction's short reference code.","example":"TXNMW9PCWE"},"status":{"type":"string","description":"The current status of the transaction.","enum":["CREATED","PENDING","PROCESSING","SUCCESSFUL","REFUNDED","DISPUTED","FAILED","CANCELED","REVERSED"],"example":"SUCCESSFUL"},"tenant":{"type":"object","description":"The tenant that originated the transaction.","example":{"uuid":"ten_0521aadc-5fbd-4b3c-af0a-a4f4b8d6f20"}},"type":{"type":"string","description":"The type of transaction.","example":"PAYMENT"},"creation_source":{"type":"string","description":"The creation source channel of the transaction.","example":"MERCHANT_PORTAL"},"amount":{"type":"integer","description":"The amount of money, in the smallest currency denomination (e.g., cents for USD).","example":10000},"variable_fee":{"type":"integer","description":"The variable fee amount charged for this transaction in the smallest currency denomination.","example":300},"fixed_fee":{"type":"integer","description":"The fixed fee amount charged for this transaction in the smallest currency denomination.","example":100},"total_fee":{"type":"integer","description":"The total fee amount charged for this transaction.","example":400},"net_amount":{"type":"integer","description":"The total net amount (amount minus total_fee) to be paid for this transaction.","example":9600},"currency":{"type":"object","description":"The transaction currency formatted in ISO 4217.","example":{"code":"USD"}},"description":{"type":"string","description":"The customer-facing description of this transaction.","example":"Insurance policy renewal - INV12324"},"remarks":{"type":"string","description":"Internal remarks or notes associated with the transaction.","example":"REQUESTED_BY_MERCHANT\\nOther values here."},"funding_source":{"type":"object","description":"The funding source account used to pay for this transaction.","example":{"uuid":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"}},"statement_descriptor":{"type":"string","description":"The value that will appear on your customers' statements. Must contain at least one letter and be between 4 and 22 characters.","example":"NOVO BILLING* INV12324"},"primary_reference":{"type":"string","description":"An optional primary external ID associated with the transaction (maximum 40 characters).","example":"ABC123"},"secondary_reference":{"type":"string","description":"An optional secondary external ID associated with the transaction (maximum 40 characters).","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"object","description":"Key-value pairs containing custom metadata (up to 50 keys, names up to 40 characters, values up to 500 characters).","example":{"order_id":"6735"}},"decline_reason":{"type":"string","description":"The reason why a transaction was declined.","example":"INSUFFICCIENT_FUNDS"},"auto_send_receipt":{"type":"boolean","description":"If true, the system will automatically generate and send a receipt using the preferred delivery method.","example":false},"due_date":{"type":"string","description":"The transaction due date in ISO-8601 format.","example":"2021-11-15"},"date_created_gmt":{"type":"string","description":"The UTC timestamp of when the transaction was created.","example":"2021-11-15T23:23:38"},"date_updated_gmt":{"type":"string","description":"The UTC timestamp of when the transaction was last updated.","example":"2021-11-15T23:23:38"},"additional_recipients":{"type":"array","description":"Information regarding split payments or additional recipient transactions created.","example":[{"tenant_id":"ten_82121783-2f4b-4f62-ad45-a32fbe4e86e7","amount":"1000","description":"Payout split by percentage","uuid":"trx_d9c67ff8-8739-462a-9b6b-932d3805e2b3"}],"items":{}}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/payments/list":{"get":{"operationId":"listPayments","summary":"List Payments","description":"Retrieve a paginated list of all payments belonging to the merchant. This endpoint returns a list of payment objects. It supports advanced filtering and search capabilities using query parameters.","tags":["Payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"The page number to return. Starts at 1.","schema":{"type":"integer"}},{"name":"page_size","in":"query","required":false,"description":"The number of items per page. Defaults to 1000 when omitted.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier of the transaction.","example":"trx_422f0f81-5001-4cce-a229-242d9ab9960a"},"code":{"type":"string","description":"The unique transaction code.","example":"TXNMW9PCWE"},"status":{"type":"string","description":"The current status of the transaction.","enum":["CREATED","PENDING","PROCESSING","SUCCESSFUL","REFUNDED","DISPUTED","FAILED","CANCELED","REVERSED"],"example":"SUCCESSFUL"},"tenant":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier of the tenant that originated the transaction."}}},"type":{"type":"string","description":"The type of transaction.","example":"PAYMENT"},"creation_source":{"type":"string","description":"The platform or source where the transaction was created.","example":"MERCHANT_PORTAL"},"amount":{"type":"integer","description":"The transaction amount, in the smallest denomination of the specified currency (e.g., cents for USD). For example, $100.00 USD is represented as 10000.","example":10000},"variable_fee":{"type":"integer","description":"The variable fee amount charged for this transaction.","example":300},"fixed_fee":{"type":"integer","description":"The fixed fee amount charged for this transaction.","example":100},"total_fee":{"type":"integer","description":"The total fee amount charged for this transaction.","example":400},"net_amount":{"type":"integer","description":"The total net amount (amount minus total_fee) to be settled for this transaction.","example":9600},"currency":{"type":"object","properties":{"code":{"type":"string","description":"The three-letter currency code in ISO 4217 format."}}},"description":{"type":"string","description":"The description of this transaction, which may be visible to end users on receipts.","example":"Insurance policy renewal - INV12324"},"remarks":{"type":"string","description":"Internal merchant remarks associated with the transaction.","example":"REQUESTED_BY_MERCHANT"},"funding_source":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier of the account used to fund this transaction."}}},"statement_descriptor":{"type":"string","description":"The billing descriptor reported to financial institutions to appear on the customer's bank statement. Must contain at least one letter and be between 4 and 22 characters.","example":"NOVO BILLING* INV12324"},"primary_reference":{"type":"string","description":"An optional primary ID associated with the transaction for mapping to internal database records. Maximum of 40 characters.","example":"ABC123"},"secondary_reference":{"type":"string","description":"An optional secondary ID associated with the transaction for mapping to internal database records. Maximum of 40 characters.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"object","description":"A set of up to 50 key-value pairs attached to the transaction. Key names can be up to 40 characters long and values up to 500 characters long.","example":{"order_id":"6735"}},"decline_reason":{"type":"string","description":"The reason why a transaction was declined, if applicable.","example":"INSUFFICIENT_FUNDS"},"auto_send_receipt":{"type":"boolean","description":"If true, a receipt is automatically generated and sent to the preferred receipt method.","example":false},"due_date":{"type":"string","description":"The due date of the transaction.","example":"2021-11-15"},"date_created_gmt":{"type":"string","description":"The GMT timestamp indicating when the transaction was created.","example":"2021-11-15T23:23:38"},"date_updated_gmt":{"type":"string","description":"The GMT timestamp indicating when the transaction was last updated.","example":"2021-11-15T23:23:38"},"additional_recipients":{"type":"array","description":"Information on any corresponding transactions created for additional split-payment recipients.","example":[{"tenant_id":"ten_82121783-2f4b-4f62-ad45-a32fbe4e86e7","amount":"1000","description":"Payout split by percentage","uuid":"trx_d9c67ff8-8739-462a-9b6b-932d3805e2b3"}],"items":{}}}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/payments/{transaction_uuid}/refund":{"put":{"operationId":"refundPayment","summary":"Refund Payment","description":"Refunds a payment transaction. Initiates a refund for a previously processed transaction identified by its UUID and returns the updated Transaction object.","tags":["Payments"],"parameters":[{"name":"transaction_uuid","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","description":"The reason for the payment refund.","example":"ACCIDENTAL_OR_DUPLICATE_CHARGE"},"note":{"type":"string","description":"An optional note describing the refund in detail.","example":"Possible Duplicate"}},"required":["reason"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The Transaction's UUID.","example":"trx_422f0f81-5001-4cce-a229-242d9ab9960a"},"code":{"type":"string","description":"The Transaction's code.","example":"TXNMW9PCWE"},"status":{"type":"string","description":"The Transaction's status.","enum":["CREATED","PENDING","PROCESSING","SUCCESSFUL","REFUNDED","DISPUTED","FAILED","CANCELED","REVERSED"],"example":"SUCCESSFUL"},"tenant":{"type":"object","description":"The tenant that originated the transaction.","example":{"uuid":"ten_0521aadc-5fbd-4b3c-af0a-a4f4b8d6f20"}},"type":{"type":"string","description":"The type of transaction.","example":"PAYMENT"},"creation_source":{"type":"string","description":"The creation source of the transaction.","example":"MERCHANT_PORTAL"},"amount":{"type":"integer","description":"The transaction amount in the smallest denomination of the currency (e.g., in cents for USD). For example, $10.00 USD is represented as 1000.","example":10000},"variable_fee":{"type":"integer","description":"The variable fee amount for this transaction.","example":300},"fixed_fee":{"type":"integer","description":"The fixed fee amount for this transaction.","example":100},"total_fee":{"type":"integer","description":"The total fee amount charged for this transaction.","example":400},"net_amount":{"type":"integer","description":"The total net amount (amount minus total_fee) for this transaction.","example":9600},"currency":{"type":"object","description":"The currency code represented in ISO 4217 format.","example":{"code":"USD"}},"description":{"type":"string","description":"The description of this transaction. Users may see this description on receipts sent by DRUO on your behalf.","example":"Insurance policy renewal - INV12324"},"remarks":{"type":"string","description":"The Transaction's remarks.","example":"REQUESTED_BY_MERCHANT"},"funding_source":{"type":"object","description":"The ID of the account used to fund this transaction.","example":{"uuid":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"}},"statement_descriptor":{"type":"string","description":"The description reported to institutions that appears on customer statement descriptors. Must contain at least one letter and be between 4 and 22 characters.","example":"NOVO BILLING* INV12324"},"primary_reference":{"type":"string","description":"An optional primary ID associated with the transaction for your internal reference. Maximum length is 40 characters.","example":"ABC123"},"secondary_reference":{"type":"string","description":"An optional secondary ID associated with the transaction for your internal reference. Maximum length is 40 characters.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"string","description":"A set of key-value pairs you can attach to the object. Up to 50 keys, with key names up to 40 characters and values up to 500 characters.","example":{"order_id":"6735"}},"decline_reason":{"type":"string","description":"The reason why a transaction was declined.","example":"INSUFFICIENT_FUNDS"},"auto_send_receipt":{"type":"boolean","description":"If true, the system automatically generates and sends a receipt to the preferred contact method.","example":false},"due_date":{"type":"string","description":"The date when the transaction will be processed.","example":"2021-11-15"},"date_created_gmt":{"type":"string","description":"The transaction creation date and time (GMT).","example":"2021-11-15T23:23:38"},"date_updated_gmt":{"type":"string","description":"The transaction's last updated date and time (GMT).","example":"2021-11-15T23:23:38"}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/payouts/create":{"post":{"operationId":"createPayout","summary":"Create Payout","description":"Create a new payout transaction. This endpoint registers a payout request and creates a Transaction object to track the movement of funds to the destination account.","tags":["Payouts"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tenant_id":{"type":"string","description":"The ID of the Tenant that originated the payout transaction.","example":"ten_0521aadc-5fbd-4b3c-af0a-a4f4b8d6f20a"},"amount":{"type":"integer","description":"The amount of money, in the smallest denomination of the currency indicated (e.g., in cents for USD). For example, $10.00 USD is represented as 1000.","example":10000},"destination_account_id":{"type":"string","description":"The ID of the account where the funds from this transaction will be deposited.","example":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"},"currency":{"type":"string","description":"The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.","example":"USD"},"merchant_id":{"type":"string","description":"The ID of the merchant associated with this payout transaction.","example":"mer_fe1b01b8-66f9-4bef-be36-5cb2ebacc004"},"description":{"type":"string","description":"The description of this transaction, visible from the Portal and API.","example":"Insurance policy renewal - INV12324"},"primary_reference":{"type":"string","description":"An optional primary ID you can associate with the transaction for your own tracking purposes (such as to associate the transaction with an entity ID in your own database). This value cannot exceed 40 characters.","example":"ABC123"},"secondary_reference":{"type":"string","description":"An optional secondary ID you can associate with the transaction for your own tracking purposes. This value cannot exceed 40 characters.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long.","example":{"order_id":"6735"}}},"required":["tenant_id","amount","destination_account_id","currency"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier (UUID) of the transaction.","example":"trx_422f0f81-5001-4cce-a229-242d9ab9960a"},"code":{"type":"string","description":"The internal reference code of the transaction.","example":"TXNMW9PCWE"},"status":{"type":"string","description":"The current status of the transaction.","example":"SUCCESSFUL"},"remarks":{"type":"string","description":"The remarks or supplementary status messages for the transaction.","example":"INSUFFICIENT_FUNDS"},"tenant":{"type":"object","description":"The tenant object that originated the transaction.","example":{"uuid":"ten_0521aadc-5fbd-4b3c-af0a-a4f4b8d6f20a"}},"creation_source":{"type":"string","description":"The creation source of the transaction.","example":"MERCHANT_API"},"destination_account":{"type":"object","description":"The destination account object where funds are deposited.","example":{"uuid":"acc_0521aadc-5fbd-4b3c-af0a-a4f4b8d6f20a"}},"type":{"type":"string","description":"The type of transaction.","example":"PAYOUT"},"amount":{"type":"integer","description":"The amount of money, in the smallest denomination of the currency.","example":10000},"currency":{"type":"object","description":"The currency object containing currency details.","example":{"code":"USD"}},"description":{"type":"string","description":"The description of this transaction, which users may see (e.g., in email receipts sent on your behalf).","example":"Insurance policy renewal - INV12324"},"primary_reference":{"type":"string","description":"The primary reference identifier associated with the transaction.","example":"ABC123"},"secondary_reference":{"type":"string","description":"The secondary reference identifier associated with the transaction.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"object","description":"Key-value pairs associated with the transaction object.","example":{"order_id":"6735"}},"decline_reason":{"type":"string","description":"The reason why the transaction was declined, if applicable.","example":"INSUFFICCIENT_FUNDS"},"date_created_gmt":{"type":"string","description":"The date and time the transaction was created, in GMT ISO format.","example":"2021-11-15T23:23:38"},"date_updated_gmt":{"type":"string","description":"The date and time the transaction was last updated, in GMT ISO format.","example":"2021-11-15T23:23:38"},"net_amount":{"type":"integer","description":"The net amount of the transaction.","example":20400},"fixed_fee":{"type":"integer","description":"The fixed fee applied to the transaction.","example":0},"total_fee":{"type":"integer","description":"The total fee applied to the transaction.","example":400},"variable_fee":{"type":"integer","description":"The variable fee applied to the transaction.","example":400}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/payouts/{transaction_uuid}":{"get":{"operationId":"getPayout","summary":"Get Payout","description":"Retrieve the details of an existing payout. Returns the details of a specific payout transaction using its unique UUID. This includes its status, amounts, fees, and references.","tags":["Payouts"],"parameters":[{"name":"transaction_uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier of the transaction.","example":"trx_422f0f81-5001-4cce-a229-242d9ab9960a"},"code":{"type":"string","description":"The unique code associated with the transaction.","example":"TXNMW9PCWE"},"status":{"type":"string","description":"The current status of the transaction.","example":"SUCCESSFUL"},"remarks":{"type":"string","description":"The transaction's remarks.","example":"INSUFFICIENT_FUNDS"},"tenant":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier of the tenant that originated the transaction."}}},"creation_source":{"type":"string","description":"The source that initiated the transaction.","example":"MERCHANT_API"},"destination_account":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier of the destination account."}}},"type":{"type":"string","description":"The type of transaction.","example":"PAYOUT"},"amount":{"type":"integer","description":"The amount of money in the smallest denomination of the currency (e.g., cents for USD).","example":10000},"currency":{"type":"object","properties":{"code":{"type":"string","description":"The three-letter ISO 4217 currency code."}}},"description":{"type":"string","description":"An optional description of the transaction. Users may see this description in email receipts.","example":"Insurance policy renewal - INV12324"},"primary_reference":{"type":"string","description":"An optional primary identifier associated with the transaction for tracking in your own database. Maximum of 40 characters.","example":"ABC123"},"secondary_reference":{"type":"string","description":"An optional secondary identifier associated with the transaction for tracking in your own database. Maximum of 40 characters.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"object","description":"A set of key-value pairs that can be attached to the object. Up to 50 keys, with key names up to 40 characters and values up to 500 characters.","example":{"order_id":"6735"}},"decline_reason":{"type":"string","description":"The reason why the transaction was declined.","example":"INSUFFICIENT_FUNDS"},"date_created_gmt":{"type":"string","description":"The date and time the transaction was created, in GMT.","example":"2021-11-15T23:23:38"},"date_updated_gmt":{"type":"string","description":"The date and time the transaction was last updated, in GMT.","example":"2021-11-15T23:23:38"},"net_amount":{"type":"integer","description":"The transaction's net amount.","example":20400},"fixed_fee":{"type":"integer","description":"The transaction's fixed fee amount.","example":0},"total_fee":{"type":"integer","description":"The transaction's total fee amount.","example":400},"variable_fee":{"type":"integer","description":"The transaction's variable fee amount.","example":400}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/payouts/list":{"get":{"operationId":"listPayouts","summary":"List Payouts","description":"Retrieve a list of payouts associated with a business. This list is paginated and supports advanced filtering and search capabilities based on query parameters such as status and transaction identifiers.","tags":["Payouts"],"parameters":[{"name":"page","in":"query","required":false,"description":"The page number to return. Starts at 1.","schema":{"type":"integer"}},{"name":"page_size","in":"query","required":false,"description":"The number of items per page. Defaults to 1000 when omitted.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier (UUID) of the transaction.","example":"trx_422f0f81-5001-4cce-a229-242d9ab9960a"},"code":{"type":"string","description":"The unique short code of the transaction.","example":"TXNMW9PCWE"},"status":{"type":"string","description":"The current status of the transaction.","example":"SUCCESSFUL"},"remarks":{"type":"string","description":"Additional system remarks or notes regarding the transaction status.","example":"INSUFFICIENT_FUNDS"},"tenant":{"type":"object","description":"The tenant object containing the identifier of the tenant that originated the transaction.","example":{"uuid":"ten_0521aadc-5fbd-4b3c-af0a-a4f4b8d6f20a"}},"creation_source":{"type":"string","description":"The system or API channel that initiated the transaction creation.","example":"MERCHANT_API"},"destination_account":{"type":"object","description":"The destination account object for the payout.","example":{"uuid":"acc_0521aadc-5fbd-4b3c-af0a-a4f4b8d6f20a"}},"type":{"type":"string","description":"The transaction type, which is always PAYOUT for this endpoint.","example":"PAYOUT"},"amount":{"type":"integer","description":"The transaction amount in the smallest denomination of the currency (e.g., cents for USD). For example, $100.00 USD is represented as 10000.","example":10000},"currency":{"type":"object","description":"The ISO 4217 currency object representing the currency of the transaction.","example":{"code":"USD"}},"description":{"type":"string","description":"An optional description of the transaction, which may be displayed to users in receipts or notifications.","example":"Insurance policy renewal - INV12324"},"primary_reference":{"type":"string","description":"An optional primary identifier used to associate the transaction with an entity in your internal database. Maximum length is 40 characters.","example":"ABC123"},"secondary_reference":{"type":"string","description":"An optional secondary identifier used to associate the transaction with an entity in your internal database. Maximum length is 40 characters.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"object","description":"Custom key-value pairs associated with the transaction. You can specify up to 50 keys, with key names up to 40 characters and values up to 500 characters.","example":{"order_id":"6735"}},"decline_reason":{"type":"string","description":"The reason why the transaction was declined, if applicable.","example":"INSUFFICCIENT_FUNDS"},"date_created_gmt":{"type":"string","description":"The date and time the transaction was created in GMT.","example":"2021-11-15T23:23:38"},"date_updated_gmt":{"type":"string","description":"The date and time the transaction was last updated in GMT.","example":"2021-11-15T23:23:38"},"net_amount":{"type":"integer","description":"The net amount of the transaction after fees.","example":20400},"fixed_fee":{"type":"integer","description":"The fixed fee applied to the transaction.","example":0},"total_fee":{"type":"integer","description":"The total processing fee applied to the transaction.","example":400},"variable_fee":{"type":"integer","description":"The variable fee applied to the transaction.","example":400}}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/transfers/create":{"post":{"operationId":"createTransfer","summary":"Create Transfer","description":"Create a new transfer request. This endpoint initiates a transfer of funds from an origin account to a destination account, creating a transaction object to track the payment's lifecycle.","tags":["Transfers"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tenant_id":{"type":"string","description":"The ID of the tenant that originated the transaction.","example":"ten_0521aadc-5fbd-4b3c-af0a-a4f4b8d6f20a"},"amount":{"type":"integer","description":"The transaction amount, represented in the smallest denomination of the specified currency (e.g., cents for USD, so $10.00 is 1000).","example":10000},"description":{"type":"string","description":"The description of this transaction. End users may see this description in automatic email receipts sent on your behalf.","example":"Insurance policy renewal - INV12324"},"statement_descriptor":{"type":"string","description":"The description reported to financial institutions to appear on customer statements. This may not be honored by all institutions. Must be between 4 and 22 characters and contain at least one letter.","example":"NOVO BILLING* INV12324"},"auto_send_receipt":{"type":"boolean","description":"If true, a receipt is automatically generated and sent via the preferred receipt method.","example":false},"origin_account_id":{"type":"string","description":"The ID of the account used to fund this transaction.","example":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"},"destination_account_id":{"type":"string","description":"The ID of the destination account for this transaction.","example":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"},"currency":{"type":"string","description":"The 3-letter currency code in ISO 4217 format.","example":"USD"},"primary_reference":{"type":"string","description":"An optional primary ID associated with the transaction for your own internal tracking. Maximum 40 characters.","example":"ABC123"},"secondary_reference":{"type":"string","description":"An optional secondary ID associated with the transaction for your own internal tracking. Maximum 40 characters.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"object","description":"A set of key-value pairs attached to the transaction object. You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long.","example":{"order_id":"6735"}}},"required":["tenant_id","amount","description","statement_descriptor","auto_send_receipt","origin_account_id","destination_account_id","currency"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The transaction's unique identifier.","example":"trx_422f0f81-5001-4cce-a229-242d9ab9960a"},"code":{"type":"string","description":"The transaction's short reference code.","example":"TXNMW9PCWE"},"status":{"type":"string","description":"The current status of the transaction.","enum":["CREATED","PENDING","PROCESSING","SUCCESSFUL","REFUNDED","DISPUTED","FAILED","CANCELED","REVERSED"],"example":"SUCCESSFUL"},"tenant":{"type":"object","description":"The unique identifier object of the tenant that originated the transaction.","example":{"uuid":"ten_0521aadc-5fbd-4b3c-af0a-a4f4b8d6f20a"}},"type":{"type":"string","description":"The type of transaction.","example":"TRANSFER"},"creation_source":{"type":"string","description":"The initiation source of the transaction.","example":"MERCHANT_PORTAL"},"amount":{"type":"integer","description":"The transaction amount, represented in the smallest denomination of the specified currency.","example":10000},"variable_fee":{"type":"integer","description":"The variable fee amount charged for this transaction.","example":300},"fixed_fee":{"type":"integer","description":"The fixed fee amount charged for this transaction.","example":100},"total_fee":{"type":"integer","description":"The total fee amount charged for this transaction.","example":400},"net_amount":{"type":"integer","description":"The total net amount (amount minus total_fee) to be settled for this transaction.","example":9600},"currency":{"type":"object","description":"The transaction currency details.","example":{"code":"USD"}},"description":{"type":"string","description":"The description of this transaction.","example":"Insurance policy renewal - INV12324"},"remarks":{"type":"string","description":"Additional remarks or internal notes about the transaction status.","example":"REQUESTED_BY_MERCHANT"},"origin_account":{"type":"string","description":"The ID of the account used to fund this transaction.","example":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"},"destination_account":{"type":"string","description":"The ID of the destination account for this transaction.","example":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"},"statement_descriptor":{"type":"string","description":"The statement descriptor reported to financial institutions.","example":"NOVO BILLING* INV12324"},"primary_reference":{"type":"string","description":"An optional primary ID associated with the transaction for your own internal tracking.","example":"ABC123"},"secondary_reference":{"type":"string","description":"An optional secondary ID associated with the transaction for your own internal tracking.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"object","description":"A set of key-value pairs attached to the transaction object.","example":{"order_id":"6735"}},"decline_reason":{"type":"string","description":"The reason why the transfer was declined, if applicable.","example":"<decline_reason>"},"auto_send_receipt":{"type":"boolean","description":"If true, a receipt is automatically generated and sent.","example":false},"date_created_gmt":{"type":"string","description":"The date and time when the transaction was created, in GMT.","example":"2021-11-15T23:23:38"},"date_updated_gmt":{"type":"string","description":"The date and time when the transaction was last updated, in GMT.","example":"2021-11-15T23:23:38"}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/transfers/{transaction_uuid}":{"get":{"operationId":"getTransfer","summary":"Get Transfer","description":"Retrieve the details of an existing transfer transaction. Returns the details of a specific transfer transaction by its unique identifier (UUID). This includes status, amount, associated fees, currencies, accounts involved, and metadata.","tags":["Transfers"],"parameters":[{"name":"transaction_uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier (UUID) of the transaction.","example":"trx_422f0f81-5001-4cce-a229-242d9ab9960a"},"code":{"type":"string","description":"The transaction's short reference code.","example":"TXNMW9PCWE"},"status":{"type":"string","description":"The current status of the transaction.","enum":["CREATED","PENDING","PROCESSING","SUCCESSFUL","REFUNDED","DISPUTED","FAILED","CANCELED","REVERSED"],"example":"SUCCESSFUL"},"tenant":{"type":"object","description":"The tenant object containing the unique identifier of the tenant associated with the transaction.","example":{"uuid":"ten_12312_asdfasdf_123aa"}},"type":{"type":"string","description":"The type of transaction.","example":"TRANSFER"},"creation_source":{"type":"string","description":"The channel or platform where the transaction was initiated.","example":"MERCHANT_PORTAL"},"amount":{"type":"integer","description":"The transaction amount in the smallest currency denomination (e.g., cents for USD or centavos for COP). For example, $100.00 USD is represented as 10000.","example":10000},"variable_fee":{"type":"integer","description":"The variable fee charged for this transaction, in the smallest currency denomination.","example":300},"fixed_fee":{"type":"integer","description":"The fixed fee charged for this transaction, in the smallest currency denomination.","example":100},"total_fee":{"type":"integer","description":"The total fee amount charged for this transaction (fixed_fee plus variable_fee), in the smallest currency denomination.","example":400},"net_amount":{"type":"integer","description":"The total net amount (amount minus total_fee) to be settled for this transaction, in the smallest currency denomination.","example":9600},"currency":{"type":"object","description":"The currency of the transaction in ISO 4217 format.","example":{"code":"USD"}},"description":{"type":"string","description":"An optional description of the transaction, which may be shown to customers (e.g., in email receipts).","example":"Insurance policy renewal - INV12324"},"remarks":{"type":"string","description":"Internal notes or remarks about the transaction.","example":"REQUESTED_BY_MERCHANT"},"origin_account":{"type":"string","description":"The ID of the account used to fund this transaction.","example":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"},"destination_account":{"type":"string","description":"The ID of the destination account receiving this transaction.","example":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"},"statement_descriptor":{"type":"string","description":"The dynamic text that will appear on your customer's bank statement. This value must contain at least one letter and be between 4 and 22 characters.","example":"NOVO BILLING* INV12324"},"primary_reference":{"type":"string","description":"An optional reference ID from your internal system to associate with this transaction. Maximum 40 characters.","example":"ABC123"},"secondary_reference":{"type":"string","description":"An optional secondary reference ID from your internal system. Maximum 40 characters.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"object","description":"Custom key-value pairs attached to the transaction object. Supports up to 50 keys, with key names up to 40 characters and values up to 500 characters.","example":{"order_id":"6735"}},"decline_reason":{"type":"string","description":"The reason why the transfer was declined, if applicable.","example":"Insufficient funds"},"auto_send_receipt":{"type":"boolean","description":"Indicates whether the system automatically sends a receipt to the customer's preferred delivery channel.","example":false},"date_created_gmt":{"type":"string","description":"The date and time when the transaction was created, in GMT.","example":"2021-11-15T23:23:38"},"date_updated_gmt":{"type":"string","description":"The date and time when the transaction was last updated, in GMT.","example":"2021-11-15T23:23:38"}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/transfers/list":{"get":{"operationId":"listTransfers","summary":"List Transfers","description":"Retrieve a paginated list of transfers belonging to the merchant. This endpoint returns a list of transfer objects and supports advanced filtering and search capabilities (such as filtering by status or end-user email) using query parameters.","tags":["Transfers"],"parameters":[{"name":"page","in":"query","required":false,"description":"The page number to return. Starts at 1.","schema":{"type":"integer"}},{"name":"page_size","in":"query","required":false,"description":"The number of items per page. Defaults to 1000 when omitted.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier (UUID) of the transaction.","example":"trx_422f0f81-5001-4cce-a229-242d9ab9960a"},"code":{"type":"string","description":"The transaction's unique code.","example":"TXNMW9PCWE"},"status":{"type":"string","description":"The current status of the transaction.","enum":["CREATED","PENDING","PROCESSING","SUCCESSFUL","REFUNDED","DISPUTED","FAILED","CANCELED","REVERSED"],"example":"SUCCESSFUL"},"tenant":{"type":"object","description":"The tenant's unique identifier object.","example":{"uuid":"trx_12312_asdfasdf_123aa"}},"type":{"type":"string","description":"The type of transaction.","example":"TRANSFER"},"creation_source":{"type":"string","description":"The creation source of the transaction.","example":"MERCHANT_PORTAL"},"amount":{"type":"integer","description":"The amount of money, in the smallest denomination of the currency indicated (e.g., in cents for USD). For example, $10.00 USD is represented as 1000.","example":10000},"variable_fee":{"type":"integer","description":"The variable fee amount for this transaction.","example":300},"fixed_fee":{"type":"integer","description":"The fixed fee amount for this transaction.","example":100},"total_fee":{"type":"integer","description":"The total fee amount charged for this transaction.","example":400},"net_amount":{"type":"integer","description":"The total net amount (total_amount minus total_fee) to be paid for this transaction.","example":9600},"currency":{"type":"object","description":"The currency of the transaction in ISO 4217 format.","example":{"code":"USD"}},"description":{"type":"string","description":"The description of this transaction. Users may see this description on receipts or statement descriptors.","example":"Insurance policy renewal - INV12324"},"remarks":{"type":"string","description":"The transaction's internal remarks.","example":"REQUESTED_BY_MERCHANT"},"origin_account":{"type":"string","description":"The ID of the account used to fund this transaction.","example":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"},"destination_account":{"type":"string","description":"The ID of the destination account for this transaction.","example":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"},"statement_descriptor":{"type":"string","description":"The description reported to financial institutions to appear on customer statements. Must contain at least one letter, and be between 4 and 22 characters.","example":"NOVO BILLING* INV12324"},"primary_reference":{"type":"string","description":"An optional primary ID you can associate with the transaction for your own purposes (such as to associate the transaction with an entity ID in your own database). This value cannot exceed 40 characters.","example":"ABC123"},"secondary_reference":{"type":"string","description":"An optional secondary ID you can associate with the transaction for your own purposes. This value cannot exceed 40 characters.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"object","description":"A set of key-value pairs that you can attach to an object. You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long.","example":{"order_id":"6735"}},"decline_reason":{"type":"string","description":"The reason why the transfer was declined, if applicable.","example":"<decline_reason>"},"auto_send_receipt":{"type":"boolean","description":"If true, the system will generate a receipt automatically to the preferred receipt method.","example":false},"date_created_gmt":{"type":"string","description":"The date and time when the transaction was created, in GMT.","example":"2021-11-15T23:23:38"},"date_updated_gmt":{"type":"string","description":"The date and time when the transaction was last updated, in GMT.","example":"2021-11-15T23:23:38"}}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/recurring-plans/create":{"post":{"operationId":"createRecurringPlan","summary":"Create Recurring Plan","description":"Creates a new Recurring Plan object. This endpoint establishes a Recurring Plan, allowing you to automate payments or transfers based on a predefined schedule and frequency. The plan can use an existing end user or define a new one inline.","tags":["Recurring Plans"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string","description":"The description of this Recurring Plan.","example":"Recurring Plan #1234567 for transaction 123455"},"processing_method":{"type":"string","description":"The processing method for the Recurring Plan.","enum":["AUTOMATIC","SEND_REQUEST"],"example":"AUTOMATIC"},"merchant_id":{"type":"string","description":"The ID of the merchant associated with this Recurring Plan.","example":"mer_fe1b01b8-66f9-4bef-be36-5cb2ebacc004"},"start_date":{"type":"string","description":"The scheduled start date. If not set, it defaults to the current date.","example":"2023-08-16T23:20:15.645Z"},"end_date":{"type":"string","description":"The scheduled end date. If not set, the plan continues indefinitely.","example":"2023-10-16T23:20:15.645Z"},"total_cycle_count":{"type":"integer","description":"The total number of cycles for the Recurring Plan.","example":4},"cycle_frequency":{"type":"string","description":"The frequency of the Recurring Plan cycles.","enum":["DAILY","WEEKLY","MONTHLY","SEMI_ANNUALLY","YEARLY"],"example":"MONTHLY"},"existing_end_user_id":{"type":"string","description":"The ID of an existing end user. Required if new_end_user_details is not provided.","example":"eur_ff6c5094-1cd1-11ec-9621-0242ac130002"},"new_end_user_details":{"type":"object","description":"The details used to create a new end user. Required only if existing_end_user_id is not provided.","example":"<new_end_user_details>"},"origin_account_id":{"type":"string","description":"The ID of the account used to fund transactions in this plan.","example":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"},"destination_account_id":{"type":"string","description":"The ID of the account that should receive the funds for transactions in this plan.","example":"acc_663f0b44-9bdb-499c-925b-2515b45dbe35"},"transaction":{"type":"object","description":"The transaction details for the Recurring Plan.","example":{},"properties":{"tenant_id":{"type":"string","description":"The ID of the tenant that originated the transaction."},"type":{"type":"string","description":"The transaction type.","enum":["PAYMENT","PAYOUT","TRANSFER"]},"currency":{"type":"string","description":"The type of currency in ISO 4217 format."},"amount":{"type":"integer","description":"The amount of money, in the smallest denomination of the currency (e.g., cents for USD)."},"statement_descriptor":{"type":"string","description":"The description that DRUO will report to financial institutions to appear on customer statements."},"primary_reference":{"type":"string","description":"The primary reference of the transaction. Used to associate transaction records with an external system."},"secondary_reference":{"type":"string","description":"The secondary reference of the transaction. Used to associate transaction records with an external system."},"metadata":{"type":"object","description":"Key-value pairs containing transaction metadata."}},"required":["tenant_id","type","amount"]},"retry_sequence_id":{"type":"string","description":"The ID of the retry sequence used to determine retry behavior for transactions that fail due to insufficient funds.","example":"rsq_df999a4a-0077-4f66-a028-a86aee1c1e4b"},"primary_reference":{"type":"string","description":"The Recurring Plan's primary reference. Can be any value to associate the plan with an entity in an external system.","example":"23423524"},"secondary_reference":{"type":"string","description":"The Recurring Plan's secondary reference. Can be any value to associate the plan with an entity in an external system.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"object","description":"Key-value pairs containing additional information about the Recurring Plan.","example":{"order_id":"6735"}}},"required":["processing_method","transaction"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier (UUID) of the Recurring Plan.","example":"rcp_747536f4-1efd-4cad-91b3-cc8aaeed93e3"},"code":{"type":"string","description":"The unique code of the Recurring Plan.","example":"SCSCDSVFGH"},"description":{"type":"string","description":"The description of the created Recurring Plan.","example":"Recurring Plan #1234567 for transaction 123455"},"processing_method":{"type":"string","description":"The processing method for the Recurring Plan.","example":"AUTOMATIC"},"status":{"type":"string","description":"The status of the Recurring Plan.","example":"ACTIVE"},"start_date":{"type":"string","description":"The scheduled start date of the Recurring Plan.","example":"2023-08-16T23:20:15.645+00:00"},"end_date":{"type":"string","description":"The scheduled end date of the Recurring Plan.","example":"2023-10-16T23:20:15.645+00:00"},"total_cycle_count":{"type":"integer","description":"The total cycle count of the Recurring Plan.","example":4},"cycle_frequency":{"type":"string","description":"The cycle frequency of the Recurring Plan.","example":"MONTHLY"},"end_user":{"type":"object","description":"The details of the end user associated with the Recurring Plan.","example":"<end_user>"},"origin_account":{"type":"string","description":"The ID of the origin account.","example":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"},"destination_account":{"type":"string","description":"The ID of the destination account.","example":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"},"primary_reference":{"type":"string","description":"The Recurring Plan's primary reference.","example":"23423524"},"secondary_reference":{"type":"string","description":"The Recurring Plan's secondary reference.","example":"bj39fhow39fhqp3f0hfae4344"},"transaction":{"type":"object","description":"The transaction details associated with the created Recurring Plan.","example":{},"properties":{"tenant":{"type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the tenant that originated the transaction."}}},"type":{"type":"string","description":"The transaction type."},"currency":{"type":"string","description":"The currency of the transaction in ISO 4217 format."},"amount":{"type":"integer","description":"The amount of the transaction in the smallest currency unit."},"statement_descriptor":{"type":"string","description":"The descriptor showing on bank statements."},"primary_reference":{"type":"string","description":"The primary reference of the transaction."},"secondary_reference":{"type":"string","description":"The secondary reference of the transaction."},"metadata":{"type":"object","description":"The metadata associated with the transaction."}}},"metadata":{"type":"object","description":"Key-value pairs containing metadata about the Recurring Plan.","example":{"order_id":"6735"}},"date_created_gmt":{"type":"string","description":"The creation timestamp of the Recurring Plan in GMT format.","example":"2021-11-15T23:23:38Z"},"date_updated_gmt":{"type":"string","description":"The last update timestamp of the Recurring Plan in GMT format.","example":"2021-11-15T23:23:38Z"}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/recurring-plans/{recurring_plan_uuid}":{"get":{"operationId":"getRecurringPlan","summary":"Get Recurring Plan","description":"Retrieve the details of a specific recurring plan by its unique identifier. This endpoint returns the configuration, schedule, status, and associated transaction information of an existing recurring plan.","tags":["Recurring Plans"],"parameters":[{"name":"recurring_plan_uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier of the recurring plan.","example":"rcp_747536f4-1efd-4cad-91b3-cc8aaeed93e3"},"code":{"type":"string","description":"The recurring plan's unique code.","example":"SCSCDSVFGH"},"description":{"type":"string","description":"The description of the recurring plan.","example":"Recurring Plan #1234567 for transaction 123455"},"processing_method":{"type":"string","description":"The processing method for the recurring plan.","example":"AUTOMATIC"},"status":{"type":"string","description":"The current status of the recurring plan.","example":"ACTIVE"},"start_date":{"type":"string","description":"The scheduled start date and time of the recurring plan.","example":"2023-08-16T23:20:15.645+00:00"},"end_date":{"type":"string","description":"The scheduled end date and time of the recurring plan.","example":"2023-10-16T23:20:15.645+00:00"},"total_cycle_count":{"type":"string","description":"The total number of cycles in the recurring plan.","example":"4"},"cycle_frequency":{"type":"string","description":"The cycle frequency of the recurring plan.","example":"MONTHLY"},"end_user":{"type":"object","description":"The full end user object associated with this recurring plan.","example":"<end_user>"},"origin_account":{"type":"string","description":"The unique identifier of the origin account.","example":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"},"destination_account":{"type":"string","description":"The unique identifier of the destination account.","example":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"},"primary_reference":{"type":"string","description":"A primary reference value to associate the recurring plan with an entity in an external system.","example":"23423524"},"secondary_reference":{"type":"string","description":"A secondary reference value to associate the recurring plan with an entity in an external system.","example":"bj39fhow39fhqp3f0hfae4344"},"transaction":{"type":"object","description":"The transaction details associated with the recurring plan.","example":{},"properties":{"tenant":{"type":"object","description":"The tenant information related to the transaction.","properties":{"uuid":{"type":"string","description":"The unique identifier of the tenant."}}},"type":{"type":"string","description":"The type of the transaction."},"currency":{"type":"string","description":"The currency of the transaction."},"amount":{"type":"integer","description":"The transaction amount in the smallest currency unit."},"statement_descriptor":{"type":"string","description":"The statement descriptor for the transaction."},"primary_reference":{"type":"string","description":"The primary reference of the transaction."},"secondary_reference":{"type":"string","description":"The secondary reference of the transaction."},"metadata":{"type":"object","description":"Key-value pairs containing metadata for the transaction."}}},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to the object.","example":{"order_id":"6735"}},"date_created_gmt":{"type":"string","description":"The creation date and time of the recurring plan in GMT.","example":"2021-11-15T23:23:38Z"},"date_updated_gmt":{"type":"string","description":"The last update date and time of the recurring plan in GMT.","example":"2021-11-15T23:23:38Z"}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/recurring-plans/list":{"get":{"operationId":"listRecurringPlans","summary":"List Recurring Plans","description":"Retrieve a list of all recurring plans belonging to the business. This endpoint retrieves a paginated list of recurring plans. It supports advanced filtering and search capabilities using query parameters.","tags":["Recurring Plans"],"parameters":[{"name":"page","in":"query","required":false,"description":"The page number to return. Starts at 1.","schema":{"type":"integer"}},{"name":"page_size","in":"query","required":false,"description":"The number of items per page. Defaults to 1000 when omitted.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier of the recurring plan.","example":"rcp_747536f4-1efd-4cad-91b3-cc8aaeed93e3"},"code":{"type":"string","description":"The unique code of the recurring plan.","example":"SCSCDSVFGH"},"description":{"type":"string","description":"The description of the recurring plan.","example":"Recurring Plan #1234567 for transaction 123455"},"processing_method":{"type":"string","description":"The processing method used for the recurring plan.","example":"AUTOMATIC"},"status":{"type":"string","description":"The current status of the recurring plan.","example":"ACTIVE"},"start_date":{"type":"string","description":"The scheduled start date and time of the recurring plan.","example":"2023-08-16T23:20:15.645+00:00"},"end_date":{"type":"string","description":"The scheduled end date and time of the recurring plan.","example":"2023-10-16T23:20:15.645+00:00"},"total_cycle_count":{"type":"integer","description":"The total number of cycles for the recurring plan.","example":4},"cycle_frequency":{"type":"string","description":"The frequency of the recurring plan's cycles.","example":"MONTHLY"},"end_user":{"type":"object","description":"The End User object associated with the recurring plan.","example":"<end_user>"},"origin_account":{"type":"string","description":"The unique identifier of the origin account for the recurring plan.","example":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"},"destination_account":{"type":"string","description":"The unique identifier of the destination account for the recurring plan.","example":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"},"primary_reference":{"type":"string","description":"The primary reference key used to associate the recurring plan with an external system entity.","example":"23423524"},"secondary_reference":{"type":"string","description":"The secondary reference key used to associate the recurring plan with an external system entity.","example":"bj39fhow39fhqp3f0hfae4344"},"transaction":{"type":"object","description":"The transaction configuration template for the recurring plan.","example":{},"properties":{"tenant":{"type":"object","description":"The tenant associated with the transaction.","properties":{"uuid":{"type":"string","description":"The unique identifier of the tenant."}}},"type":{"type":"string","description":"The transaction type (e.g., PAYMENT)."},"currency":{"type":"string","description":"The currency code for the transaction."},"amount":{"type":"integer","description":"The transaction amount in cents."},"statement_descriptor":{"type":"string","description":"The statement descriptor displayed on bank statements."},"primary_reference":{"type":"string","description":"The primary reference of the transaction."},"secondary_reference":{"type":"string","description":"The secondary reference of the transaction."},"metadata":{"type":"object","description":"Metadata associated with the transaction."}}},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to the recurring plan. Up to 50 keys are supported, with key names up to 40 characters and values up to 500 characters.","example":{"order_id":"6735"}},"date_created_gmt":{"type":"string","description":"The creation date and time of the recurring plan in GMT.","example":"2021-11-15T23:23:38Z"},"date_updated_gmt":{"type":"string","description":"The last update date and time of the recurring plan in GMT.","example":"2021-11-15T23:23:38Z"}}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/recurring-plans/{recurring_plan_uuid}/activate":{"put":{"operationId":"activateRecurringPlan","summary":"Activate Recurring Plan","description":"Activates an existing recurring plan. Updates the status of a recurring plan to ACTIVE using its unique identifier. This enables the recurring plan to start executing transactions according to its defined cycle schedule.","tags":["Recurring Plans"],"parameters":[{"name":"recurring_plan_uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier (UUID) of the recurring plan.","example":"rcp_747536f4-1efd-4cad-91b3-cc8aaeed93e3"},"code":{"type":"string","description":"The unique code associated with the recurring plan.","example":"SCSCDSVFGH"},"description":{"type":"string","description":"The description of the recurring plan.","example":"Recurring Plan #1234567 for transaction 123455"},"processing_method":{"type":"string","description":"The processing method utilized by the recurring plan.","example":"AUTOMATIC"},"status":{"type":"string","description":"The current status of the recurring plan.","example":"ACTIVE"},"start_date":{"type":"string","description":"The scheduled start date and time for the recurring plan.","example":"2023-08-16T23:20:15.645+00:00"},"end_date":{"type":"string","description":"The scheduled end date and time for the recurring plan.","example":"2023-10-16T23:20:15.645+00:00"},"total_cycle_count":{"type":"string","description":"The total number of cycles scheduled for the recurring plan.","example":"4"},"cycle_frequency":{"type":"string","description":"The frequency of the recurring plan's cycles.","example":"MONTHLY"},"end_user":{"type":"object","description":"The full End User object related to this recurring plan.","example":"<end_user>"},"origin_account":{"type":"string","description":"The unique identifier (UUID) of the origin account.","example":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"},"destination_account":{"type":"string","description":"The unique identifier (UUID) of the destination account.","example":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"},"primary_reference":{"type":"string","description":"The primary reference of the recurring plan, used to associate it with an entity in an external system.","example":"23423524"},"secondary_reference":{"type":"string","description":"The secondary reference of the recurring plan, used to associate it with an entity in an external system.","example":"bj39fhow39fhqp3f0hfae4344"},"transaction":{"type":"object","description":"The transaction details associated with the recurring plan.","example":{},"properties":{"tenant":{"type":"object","description":"The tenant details associated with the transaction.","properties":{"uuid":{"type":"string","description":"The unique identifier (UUID) of the tenant."}}},"type":{"type":"string","description":"The transaction type."},"currency":{"type":"string","description":"The currency code for the transaction."},"amount":{"type":"integer","description":"The transaction amount in the smallest currency unit."},"statement_descriptor":{"type":"string","description":"The statement descriptor for the transaction."},"primary_reference":{"type":"string","description":"The primary reference associated with the transaction."},"secondary_reference":{"type":"string","description":"The secondary reference associated with the transaction."},"metadata":{"type":"object","description":"Key-value pairs containing metadata about the transaction."}}},"metadata":{"type":"object","description":"A set of key-value pairs that you can attach to an object. You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long.","example":{"order_id":"6735"}},"date_created_gmt":{"type":"string","description":"The creation date and time of the recurring plan in GMT.","example":"2021-11-15T23:23:38Z"},"date_updated_gmt":{"type":"string","description":"The last update date and time of the recurring plan in GMT.","example":"2021-11-15T23:23:38Z"}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/recurring-plans/{recurring_plan_uuid}/pause":{"put":{"operationId":"pauseRecurringPlan","summary":"Pause Recurring Plan","description":"Pause an active recurring plan. Updates the status of a specific recurring plan to PAUSED using its unique identifier.","tags":["Recurring Plans"],"parameters":[{"name":"recurring_plan_uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier of the recurring plan.","example":"rcp_747536f4-1efd-4cad-91b3-cc8aaeed93e3"},"code":{"type":"string","description":"The unique code of the recurring plan.","example":"SCSCDSVFGH"},"description":{"type":"string","description":"The description of the recurring plan.","example":"Recurring Plan #1234567 for transaction 123455"},"processing_method":{"type":"string","description":"The processing method utilized by the recurring plan.","example":"AUTOMATIC"},"status":{"type":"string","description":"The current status of the recurring plan.","example":"PAUSED"},"start_date":{"type":"string","description":"The scheduled start date and time of the recurring plan.","example":"2023-08-16T23:20:15.645+00:00"},"end_date":{"type":"string","description":"The scheduled end date and time of the recurring plan.","example":"2023-10-16T23:20:15.645+00:00"},"total_cycle_count":{"type":"string","description":"The total number of cycles scheduled for the recurring plan.","example":"4"},"cycle_frequency":{"type":"string","description":"The cycle frequency of the recurring plan.","example":"MONTHLY"},"end_user":{"type":"object","description":"The full End User object associated with this recurring plan.","example":"<end_user>"},"origin_account":{"type":"string","description":"The unique identifier of the origin account for the recurring plan.","example":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"},"destination_account":{"type":"string","description":"The unique identifier of the destination account for the recurring plan.","example":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"},"primary_reference":{"type":"string","description":"An optional primary reference to associate the recurring plan with an external system entity.","example":"23423524"},"secondary_reference":{"type":"string","description":"An optional secondary reference to associate the recurring plan with an external system entity.","example":"bj39fhow39fhqp3f0hfae4344"},"transaction":{"type":"object","description":"The transaction information that belongs to the created recurring plan.","example":{"tenant":{"uuid":"22637d15-5b37-4fb2-90e5-aa8751970469"},"type":"PAYMENT","currency":"USD","amount":10000,"statement_descriptor":"NOVO BILLING* INV12324","primary_reference":"Transaction primary reference","secondary_reference":"Transaction secondary reference","metadata":{"id_user":"69440","transaction_xyz":"JOHN SMITH"}}},"metadata":{"type":"object","description":"A set of key-value pairs that can be attached to the object. Supports up to 50 keys, with key names up to 40 characters long and values up to 500 characters long.","example":{"order_id":"6735"}}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/recurring-plans/{recurring_plan_uuid}/cancel":{"put":{"operationId":"cancelRecurringPlan","summary":"Cancel Recurring Plan","description":"Cancels an active recurring plan. Updates the status of a specific recurring plan to CANCELED, preventing any future payment cycles from being processed.","tags":["Recurring Plans"],"parameters":[{"name":"recurring_plan_uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier of the Recurring Plan.","example":"rcp_747536f4-1efd-4cad-91b3-cc8aaeed93e3"},"code":{"type":"string","description":"The unique code of the Recurring Plan.","example":"SCSCDSVFGH"},"description":{"type":"string","description":"The description of the Recurring Plan.","example":"Recurring Plan #1234567 for transaction 123455"},"processing_method":{"type":"string","description":"The processing method used for the Recurring Plan.","example":"AUTOMATIC"},"status":{"type":"string","description":"The status of the Recurring Plan.","example":"CANCELED"},"start_date":{"type":"string","description":"The scheduled start date and time of the Recurring Plan.","example":"2023-08-16T23:20:15.645+00:00"},"end_date":{"type":"string","description":"The scheduled end date and time of the Recurring Plan.","example":"2023-10-16T23:20:15.645+00:00"},"total_cycle_count":{"type":"integer","description":"The total number of cycles for the Recurring Plan.","example":4},"cycle_frequency":{"type":"string","description":"The frequency of the Recurring Plan cycles.","example":"MONTHLY"},"end_user":{"type":"object","description":"The end user details associated with the Recurring Plan.","example":"<end_user>"},"origin_account":{"type":"string","description":"The origin account associated with the Recurring Plan.","example":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"},"destination_account":{"type":"string","description":"The destination account associated with the Recurring Plan.","example":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"},"primary_reference":{"type":"string","description":"The primary reference used to associate the Recurring Plan with an external entity.","example":"23423524"},"secondary_reference":{"type":"string","description":"The secondary reference used to associate the Recurring Plan with an external entity.","example":"bj39fhow39fhqp3f0hfae4344"},"transaction":{"type":"object","description":"The transaction details associated with the Recurring Plan.","example":{"tenant":{"uuid":"22637d15-5b37-4fb2-90e5-aa8751970469"},"type":"PAYMENT","currency":"USD","amount":10000,"statement_descriptor":"NOVO BILLING* INV12324","primary_reference":"Transaction primary reference","secondary_reference":"Transaction secondary reference","metadata":{"id_user":"69440","transaction_xyz":"JOHN SMITH"}}},"metadata":{"type":"object","description":"A set of key-value pairs associated with the Recurring Plan.","example":{"order_id":"6735"}},"date_created_gmt":{"type":"string","description":"The creation date and time of the Recurring Plan in GMT.","example":"2021-11-15T23:23:38Z"},"date_updated_gmt":{"type":"string","description":"The last update date and time of the Recurring Plan in GMT.","example":"2021-11-15T23:23:38Z"}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/balance":{"get":{"operationId":"getBalance","summary":"Get Balance","description":"Retrieve the current balance of the merchant. Returns the merchant's total and available balances, along with the currency code.","tags":["Balance & Deposits"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"currency":{"type":"string","description":"The currency of the merchant's balance.","example":"COP"},"total":{"type":"number","description":"The merchant's total balance.","example":12000},"available":{"type":"number","description":"The merchant's available balance.","example":3000}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/deposits/{transaction_uuid}":{"get":{"operationId":"getDeposit","summary":"Get Deposit","description":"Retrieve the details of an existing deposit transaction. Returns the complete details of a specific deposit transaction using its unique transaction UUID.","tags":["Balance & Deposits"],"parameters":[{"name":"transaction_uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier of the transaction.","example":"trx_422f0f81-5001-4cce-a229-242d9ab9960a"},"code":{"type":"string","description":"The unique short code associated with the transaction.","example":"TXNMW9PCWE"},"status":{"type":"string","description":"The current status of the transaction.","example":"SUCCESSFUL"},"type":{"type":"string","description":"The type of transaction.","example":"DEPOSIT"},"tenant":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier of the tenant that originated the transaction."}}},"amount":{"type":"integer","description":"The transaction amount, in the smallest denomination of the currency (e.g., cents for USD).","example":10000},"variable_fee":{"type":"integer","description":"The variable fee applied to the transaction, in the smallest currency denomination.","example":400},"fixed_fee":{"type":"integer","description":"The fixed fee applied to the transaction, in the smallest currency denomination.","example":0},"total_fee":{"type":"integer","description":"The total fee applied to the transaction (sum of fixed and variable fees), in the smallest currency denomination.","example":400},"net_amount":{"type":"integer","description":"The net amount of the transaction, in the smallest currency denomination.","example":20400},"currency":{"type":"object","properties":{"code":{"type":"string","description":"The ISO 4217 three-letter currency code representing the transaction currency."}}},"description":{"type":"string","description":"An optional description for this transaction. This description may be visible to end users (e.g., in email receipts).","example":"Insurance policy renewal - INV12324"},"remarks":{"type":"string","description":"Additional remarks or reasons associated with the transaction status, such as failure reasons.","example":"INSUFFICIENT_FUNDS"},"destination_account":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier of the destination account for the deposit."}}},"creation_source":{"type":"string","description":"The source platform or mechanism that initiated the transaction creation.","example":"MERCHANT_API"},"primary_reference":{"type":"string","description":"An optional custom identifier associated with the transaction for your internal reference. Maximum length is 40 characters.","example":"ABC123"},"secondary_reference":{"type":"string","description":"An optional secondary custom identifier associated with the transaction for your internal reference. Maximum length is 40 characters.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"object","description":"A map of up to 50 custom key-value pairs attached to the transaction. Key names are limited to 40 characters and values to 500 characters.","example":{"order_id":"6735"}},"date_created_gmt":{"type":"string","description":"The ISO 8601 UTC date and time when the transaction was created.","example":"2021-11-15T23:23:38"},"date_updated_gmt":{"type":"string","description":"The ISO 8601 UTC date and time when the transaction was last updated.","example":"2021-11-15T23:23:38"},"related_transactions_count":{"type":"integer","description":"The total number of transactions related to this deposit.","example":2},"related_transactions":{"type":"array","description":"A list of transactions related to this deposit.","example":[{"uuid":"trx_9c0d1e2f-0000-4000-8000-000000000001","type":"PAYMENT","amount":2800000,"metadata":{"order_id":"A-9912"},"primary_reference":"ORD-9912","secondary_reference":"INV-2026-0455","tertiary_reference":null,"currency":{"code":"COP"}},{"uuid":"trx_9c0d1e2f-0000-4000-8000-000000000002","type":"PAYMENT","amount":2000000,"metadata":null,"primary_reference":"ORD-9913","secondary_reference":null,"tertiary_reference":null,"currency":{"code":"COP"}}],"items":{}}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/deposits/list":{"get":{"operationId":"listDeposits","summary":"List Deposits","description":"Retrieve a paginated list of deposits associated with a business. This endpoint returns a list of deposits and supports advanced filtering and search capabilities using query parameters such as status and page size.","tags":["Balance & Deposits"],"parameters":[{"name":"page","in":"query","required":false,"description":"The page number to return. Starts at 1.","schema":{"type":"integer"}},{"name":"page_size","in":"query","required":false,"description":"The number of items per page. Defaults to 1000 when omitted.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier (UUID) of the transaction.","example":"trx_422f0f81-5001-4cce-a229-242d9ab9960a"},"code":{"type":"string","description":"The transaction's unique tracking code.","example":"TXNMW9PCWE"},"status":{"type":"string","description":"The current status of the transaction.","example":"SUCCESSFUL"},"type":{"type":"string","description":"The type of transaction.","example":"DEPOSIT"},"tenant":{"type":"object","description":"The tenant that originated the transaction.","example":{"uuid":"ten_0521aadc-5fbd-4b3c-af0a-a4f4b8d6f20a"}},"amount":{"type":"integer","description":"The amount of money in the smallest denomination of the currency (e.g., cents for USD, so $10.00 is represented as 1000).","example":10000},"variable_fee":{"type":"integer","description":"The variable fee applied to the transaction.","example":400},"fixed_fee":{"type":"integer","description":"The fixed fee applied to the transaction.","example":0},"total_fee":{"type":"integer","description":"The total fee applied to the transaction.","example":400},"net_amount":{"type":"integer","description":"The net amount of the transaction.","example":20400},"currency":{"type":"object","description":"The transaction currency represented in ISO 4217 format.","example":{"code":"USD"}},"description":{"type":"string","description":"An optional description for the transaction, which may be visible to users in email receipts.","example":"Insurance policy renewal - INV12324"},"remarks":{"type":"string","description":"Additional remarks or reasons associated with the transaction status.","example":"INSUFFICIENT_FUNDS"},"destination_account":{"type":"object","description":"The destination account for the transaction.","example":{"uuid":"acc_0521aadc-5fbd-4b3c-af0a-a4f4b8d6f20a"}},"creation_source":{"type":"string","description":"The system or portal where the transaction was created.","example":"MERCHANT_PORTAL"},"primary_reference":{"type":"string","description":"An optional primary ID to associate with the transaction for your own record-keeping. Max 40 characters.","example":"ABC123"},"secondary_reference":{"type":"string","description":"An optional secondary ID to associate with the transaction for your own record-keeping. Max 40 characters.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"object","description":"A set of key-value pairs that can be attached to the object. You can specify up to 50 keys, with key names up to 40 characters and values up to 500 characters.","example":{"order_id":"6735"}},"date_created_gmt":{"type":"string","description":"The GMT date and time when the transaction was created.","example":"2021-11-15T23:23:38"},"date_updated_gmt":{"type":"string","description":"The GMT date and time when the transaction was last updated.","example":"2021-11-15T23:23:38"},"related_transactions_count":{"type":"integer","description":"The total number of transactions related to the deposit.","example":2},"related_transactions":{"type":"array","description":"A list of transactions related to this deposit.","example":[{"uuid":"trx_9c0d1e2f-0000-4000-8000-000000000002","type":"PAYMENT","amount":150000}],"items":{}}}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/profiles/create":{"post":{"operationId":"createProfile","summary":"Create Profile","description":"Creates a new business profile. Creates a Profile object within a platform program. This initiates the onboarding or creation flow for a merchant profile, defining its default currency, legal representatives, and banking information.","tags":["Platforms"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"platform_program_id":{"type":"string","description":"The ID of the Platform Program the new profile will join.","example":"plp_8555fd61-d666-480f-bc95-4d1d752fb000"},"type":{"type":"string","description":"The type of profile to create.","example":"MERCHANT"},"name":{"type":"string","description":"The public name of the business.","example":"Cafe Novo"},"legal_name":{"type":"string","description":"The registered legal name of the business.","example":"Cafe Novo Inc."},"local_id":{"type":"string","description":"The tax or identity number of the business, as issued in its country.","example":"1234567890"},"local_id_type":{"type":"string","description":"The type of the identifier sent in local_id.","example":"TAXPAYER_ID"},"primary_category":{"type":"string","description":"The main category of the business.","example":"FINANCIAL_AND_INSURANCE_SERVICES"},"secondary_category":{"type":"string","description":"A more specific category within the primary_category.","example":"INSURANCE"},"website":{"type":"string","description":"The business website. Must be a valid URL.","example":"https://cafenovo.com"},"default_currency":{"type":"string","description":"The default currency of the profile, in ISO 4217 format.","example":"USD"},"size":{"type":"string","description":"The size of the business, represented by its number of employees.","example":"E_2_5"},"primary_representative":{"type":"object","description":"The main person who represents the business.","example":{},"properties":{"first_name":{"type":"string","description":"The first name of the primary representative."},"last_name":{"type":"string","description":"The last name of the primary representative."},"job_title":{"type":"string","description":"The job title of the primary representative."},"email":{"type":"string","description":"The email address of the primary representative."},"phone":{"type":"object","description":"The phone number of the representative.","properties":{"country_code":{"type":"integer","description":"The international dialing code, without the + sign."},"number":{"type":"integer","description":"The phone number, without the country code."}},"required":["country_code","number"]}},"required":["first_name","last_name","job_title","email","phone"]},"deposit_account":{"type":"object","description":"The bank account where the profile receives its deposits. Some programs require it; if yours does and it is missing, the request is rejected.","example":{},"properties":{"institution_id":{"type":"string","description":"The UUID of the financial institution that holds the account."},"account_number":{"type":"string","description":"The account's number."},"subtype":{"type":"string","description":"The subtype of account. Provides further detail about the type of account."}}},"registered_address":{"type":"object","description":"The legal address of the business.","example":{},"properties":{"recipient_name":{"type":"string","description":"The name of the person the correspondence is addressed to."},"recipient_organization":{"type":"string","description":"The organization the correspondence is addressed to."},"line_1":{"type":"string","description":"Street name and number."},"line_2":{"type":"string","description":"Apartment, suite or unit."},"line_3":{"type":"string","description":"Additional address information."},"locality":{"type":"string","description":"The city or town."},"administrative_district":{"type":"string","description":"The state, province or region."},"administrative_district_code":{"type":"string","description":"The code of the state, province or region."},"administrative_district_2":{"type":"string","description":"The second-level administrative division, such as a county."},"postal_code":{"type":"string","description":"The postal or ZIP code of the registered address."},"country":{"type":"string","description":"The country, as an ISO 3166 alpha-3 code."}},"required":["line_1","locality","administrative_district","postal_code","country"]},"public_contact_information":{"type":"object","description":"The contact details shown publicly for the business.","example":{},"properties":{"support_email":{"type":"string","description":"The support email address."},"support_phone":{"type":"object","description":"The support phone number.","properties":{"country_code":{"type":"integer","description":"The international dialing code, without the + sign."},"number":{"type":"integer","description":"The phone number, without the country code."}}}}},"attestations":{"type":"object","description":"Proof that the business accepted DRUO's legal agreements.","example":{},"properties":{"terms_of_service":{"type":"object","description":"Acceptance of the Terms of Service.","properties":{"accepted":{"type":"boolean","description":"Whether the business accepted the Terms of Service."},"timestamp":{"type":"string","description":"When the Terms of Service were accepted, in ISO 8601 UTC format."},"ip":{"type":"string","description":"The IP address from which the Terms of Service were accepted."},"user_agent":{"type":"string","description":"The user agent of the browser or app used to accept the Terms of Service."},"url":{"type":"string","description":"The URL of the page where the Terms of Service were accepted."}},"required":["accepted"]},"privacy_policy":{"type":"object","description":"Acceptance of the Privacy Policy.","properties":{"accepted":{"type":"boolean","description":"Whether the business accepted the Privacy Policy."},"timestamp":{"type":"string","description":"When the Privacy Policy was accepted, in ISO 8601 UTC format."},"ip":{"type":"string","description":"The IP address from which the Privacy Policy was accepted."},"user_agent":{"type":"string","description":"The user agent of the browser or app used to accept the Privacy Policy."},"url":{"type":"string","description":"The URL of the page where the Privacy Policy was accepted."}},"required":["accepted"]}}}},"required":["platform_program_id","type","name","legal_name","local_id","local_id_type","primary_category","website","default_currency","size","primary_representative","registered_address"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The Profile's UUID.","example":"pro_f4ac8520-3de3-40d6-9059-a5da34f34123"},"code":{"type":"string","description":"The Profile's unique code.","example":"PRLX6CATF123"},"global_status":{"type":"string","description":"The status of the profile.","enum":["CREATED","WAITLISTED","ONBOARDING","REJECTED","ACTIVE","RESTRICTED","SUSPENDED","TERMINATED","DEACTIVATED","DELETED"],"example":"CREATED"},"platform_program_id":{"type":"string","description":"The ID of the Platform Program the profile belongs to.","example":"plp_8555fd61-d666-480f-bc95-4d1d752fb000"},"type":{"type":"string","description":"The type of the Profile.","example":"MERCHANT"},"name":{"type":"string","description":"The public name of the business.","example":"Cafe Novo"},"website":{"type":"string","description":"The business website.","example":"https://cafenovo.com"},"country":{"type":"string","description":"The country of the business, as an ISO 3166 alpha-3 code.","example":"USA"},"primary_category":{"type":"string","description":"The main category of the business.","example":"FINANCIAL_AND_INSURANCE_SERVICES"},"secondary_category":{"type":"string","description":"The specific category within the primary_category.","example":"INSURANCE"},"default_currency":{"type":"string","description":"The default currency of the profile, in ISO 4217 format.","example":"USD"},"environments":{"type":"array","description":"The environments in which the profile operates.","example":[{"merchant_id":"mer_03c9ecb2-5d67-47d0-88e5-0728ff2f1234","merchant_code":"MF3A7TJ1234","environment":"PRODUCTION"}],"items":{}},"creation_source":{"type":"string","description":"The creation source of the profile.","example":"MERCHANT_API"},"date_created_gmt":{"type":"string","description":"The date and time the profile was created.","example":"2026-11-10T21:34:23.081Z"},"date_updated_gmt":{"type":"string","description":"The date and time the profile was last updated.","example":"2026-11-10T21:34:23.081Z"}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/profiles/{profile_uuid}":{"get":{"operationId":"getProfile","summary":"Get Profile","description":"Retrieve the details of an existing profile. Returns the configuration, status, business categorization, and active environments of a specific Profile identified by its unique ID.","tags":["Platforms"],"parameters":[{"name":"profile_uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier of the profile.","example":"pro_f4ac8520-3de3-40d6-9059-a5da34f34123"},"code":{"type":"string","description":"The unique system code assigned to the profile.","example":"PRLX6CATF123"},"global_status":{"type":"string","description":"The global status of the profile.","enum":["CREATED","WAITLISTED","ONBOARDING","REJECTED","ACTIVE","RESTRICTED","SUSPENDED","TERMINATED","DEACTIVATED","DELETED"],"example":"CREATED"},"platform_program_id":{"type":"string","description":"The ID of the Platform Program the profile belongs to.","example":"plp_8555fd61-d666-480f-bc95-4d1d752fb000"},"type":{"type":"string","description":"The entity type of the profile.","example":"MERCHANT"},"name":{"type":"string","description":"The public-facing name of the business.","example":"Cafe Novo"},"website":{"type":"string","description":"The business website URL.","example":"https://cafenovo.com"},"country":{"type":"string","description":"The country of the business, formatted as an ISO 3166-1 alpha-3 code.","example":"USA"},"primary_category":{"type":"string","description":"The primary business category or industry sector.","example":"FINANCIAL_AND_INSURANCE_SERVICES"},"secondary_category":{"type":"string","description":"The specific sub-category within the primary business category.","example":"INSURANCE"},"default_currency":{"type":"string","description":"The default currency for the profile, formatted as an ISO 4217 code.","example":"USD"},"environments":{"type":"array","description":"The operational environments associated with this profile, each linked to its respective merchant details.","example":[{"merchant_id":"mer_03c9ecb2-5d67-47d0-88e5-0728ff2f1234","merchant_code":"MF3A7TJ1234","environment":"PRODUCTION"}],"items":{}},"creation_source":{"type":"string","description":"The origin channel from which the profile was created.","example":"MERCHANT_API"},"date_created_gmt":{"type":"string","description":"The date and time when the profile was created, in GMT ISO 8601 format.","example":"2026-11-10T21:34:23.081Z"},"date_updated_gmt":{"type":"string","description":"The date and time when the profile was last updated, in GMT ISO 8601 format.","example":"2026-11-10T21:34:23.081Z"}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/profiles/list":{"get":{"operationId":"listProfiles","summary":"List Profiles","description":"Retrieve a list of profiles associated with a business. This endpoint returns a paginated list of profiles. It supports advanced filtering and search capabilities using query parameters.","tags":["Platforms"],"parameters":[{"name":"page","in":"query","required":false,"description":"The page number to return. Starts at 1.","schema":{"type":"integer"}},{"name":"page_size","in":"query","required":false,"description":"The number of items per page. Defaults to 1000 when omitted.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier (UUID) of the profile.","example":"pro_f4ac8520-3de3-40d6-9059-a5da34f34123"},"code":{"type":"string","description":"The unique code of the profile.","example":"PRLX6CATF123"},"global_status":{"type":"string","description":"The current status of the profile.","enum":["CREATED","WAITLISTED","ONBOARDING","REJECTED","ACTIVE","RESTRICTED","SUSPENDED","TERMINATED","DEACTIVATED","DELETED"],"example":"CREATED"},"platform_program_id":{"type":"string","description":"The ID of the Platform Program to which the profile belongs.","example":"plp_8555fd61-d666-480f-bc95-4d1d752fb000"},"type":{"type":"string","description":"The type classification of the profile.","example":"MERCHANT"},"name":{"type":"string","description":"The public commercial name of the business.","example":"Cafe Novo"},"website":{"type":"string","description":"The business website URL.","example":"https://cafenovo.com"},"country":{"type":"string","description":"The country where the business is registered, as an ISO 3166-1 alpha-3 code.","example":"USA"},"primary_category":{"type":"string","description":"The primary business category or industry sector.","example":"FINANCIAL_AND_INSURANCE_SERVICES"},"secondary_category":{"type":"string","description":"The specific sub-category within the primary business category.","example":"INSURANCE"},"default_currency":{"type":"string","description":"The default operating currency for the profile, represented as an ISO 4217 code.","example":"USD"},"environments":{"type":"array","description":"The operational environments available for this profile. Each environment contains a separate merchant configuration.","example":[{"merchant_id":"mer_03c9ecb2-5d67-47d0-88e5-0728ff2f1234","merchant_code":"MF3A7TJ1234","environment":"PRODUCTION"}],"items":{}},"creation_source":{"type":"string","description":"The source channel through which the profile was created.","example":"MERCHANT_API"},"date_created_gmt":{"type":"string","description":"The date and time in GMT when the profile was created.","example":"2026-11-10T21:34:23.081Z"},"date_updated_gmt":{"type":"string","description":"The date and time in GMT when the profile was last updated.","example":"2026-11-10T21:34:23.081Z"}}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/platform-programs/{platform_program_uuid}":{"get":{"operationId":"getPlatformProgram","summary":"Get Platform Program","description":"Retrieve the details of an existing Platform Program. Returns the configuration, status, and management details of a specific Platform Program using its unique identifier.","tags":["Platforms"],"parameters":[{"name":"platform_program_uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The Platform Program's unique identifier.","example":"plp_f4ac8520-3de3-40d6-9059-a5da34f34123"},"name":{"type":"string","description":"The name of the program.","example":"Cafe Novo Reloaded"},"description":{"type":"string","description":"The description of the program.","example":"Cafe Novo Reloaded Platform Program"},"status":{"type":"string","description":"The current status of the program.","enum":["CREATED","WAITING_FOR_REVIEW","REVIEW_IN_PROGRESS","REJECTED","ACTIVE","RESTRICTED","SUSPENDED","TERMINATED"],"example":"CREATED"},"program_manager":{"type":"object","description":"The profile of the program manager that manages the program.","example":{"uuid":"pro_894a2d55-a2b5-457b-976c-fb40384f7123","role":"PROGRAM_MANAGER","status":"ACTIVE","date_updated_gmt":"2026-05-15T00:12:50.684Z","date_created_gmt":"2023-03-06T18:11:51.884Z"},"properties":{"uuid":{"type":"string","description":"The unique identifier of the managing profile."},"role":{"type":"string","description":"The role of the program manager."},"status":{"type":"string","description":"The status of the program manager's profile."},"date_updated_gmt":{"type":"string","description":"The date and time the managing profile was last updated, in GMT."},"date_created_gmt":{"type":"string","description":"The date and time the managing profile was created, in GMT."}}},"nested_members":{"type":"object","description":"The nested member settings of the program.","example":{"enrollment_status":"ACTIVE","max_number":null,"count":9},"properties":{"enrollment_status":{"type":"string","description":"The enrollment status of nested members in the program."},"max_number":{"type":"integer","description":"The maximum number of allowed nested members. Returns null if unlimited."},"count":{"type":"integer","description":"The current count of nested members enrolled."}}},"date_created_gmt":{"type":"string","description":"The date and time the Platform Program was created, in GMT.","example":"2026-11-10T21:34:23.081Z"},"date_updated_gmt":{"type":"string","description":"The date and time the Platform Program was last updated, in GMT.","example":"2026-11-10T21:34:23.081Z"}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/platform-programs/list":{"get":{"operationId":"listPlatformPrograms","summary":"List Platform Programs","description":"Retrieve a paginated list of Platform Programs associated with the caller. This endpoint returns a list of Platform Programs. It supports advanced filtering and search capabilities via query parameters, such as status and page size.","tags":["Platforms"],"parameters":[{"name":"page","in":"query","required":false,"description":"The page number to return. Starts at 1.","schema":{"type":"integer"}},{"name":"page_size","in":"query","required":false,"description":"The number of items per page. Defaults to 1000 when omitted.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier of the Platform Program.","example":"plp_f4ac8520-3de3-40d6-9059-a5da34f34123"},"name":{"type":"string","description":"The name of the program.","example":"Cafe Novo Reloaded"},"description":{"type":"string","description":"The description of the program.","example":"Cafe Novo Reloaded Platform Program"},"status":{"type":"string","description":"The current status of the program.","enum":["CREATED","WAITING_FOR_REVIEW","REVIEW_IN_PROGRESS","REJECTED","ACTIVE","RESTRICTED","SUSPENDED","TERMINATED"],"example":"CREATED"},"program_manager":{"type":"object","description":"The profile details of the program manager managing this program.","example":{"uuid":"pro_894a2d55-a2b5-457b-976c-fb40384f7123","role":"PROGRAM_MANAGER","status":"ACTIVE","date_updated_gmt":"2026-05-15T00:12:50.684Z","date_created_gmt":"2023-03-06T18:11:51.884Z"},"properties":{"uuid":{"type":"string","description":"The unique identifier of the program manager profile."},"role":{"type":"string","description":"The role assigned to the program manager."},"status":{"type":"string","description":"The status of the program manager profile."},"date_updated_gmt":{"type":"string","description":"The date and time when the program manager profile was last updated, in GMT."},"date_created_gmt":{"type":"string","description":"The date and time when the program manager profile was created, in GMT."}}},"nested_members":{"type":"object","description":"The nested member settings and statistics for the program.","example":{"enrollment_status":"ACTIVE","max_number":null,"count":9},"properties":{"enrollment_status":{"type":"string","description":"The enrollment status of nested members in the program."},"max_number":{"type":"integer","description":"The maximum number of nested members allowed in the program, if restricted."},"count":{"type":"integer","description":"The current count of nested members in the program."}}},"date_created_gmt":{"type":"string","description":"The date and time when the Platform Program was created, in GMT.","example":"2026-11-10T21:34:23.081Z"},"date_updated_gmt":{"type":"string","description":"The date and time when the Platform Program was last updated, in GMT.","example":"2026-11-10T21:34:23.081Z"}}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/transactions/initiate":{"post":{"operationId":"initiateTransaction","summary":"Initiate Transaction","description":"Initiates a new transaction. Creates a payment or transfer transaction between an origin account and a destination account. Requires Bearer Token authorization to authenticate the client.","tags":["Acquirer Transactions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"custom_id":{"type":"string","description":"The custom identifier for this transaction.","example":"12345"},"type":{"type":"string","description":"The transaction type (e.g., PAYMENT).","example":"PAYMENT"},"tenant_id":{"type":"string","description":"The ID of the Tenant that originated the transaction.","example":"ten_0521aadc-5fbd-4b3c-af0a-a4f4b8d6f20a"},"origin_account":{"type":"object","description":"The transaction's origin account details.","example":{"uuid":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340","token":"tok_e49f110e-804c-4e23-8e9c-4d4fae4c7868","institution_uuid":"ins_ff6c5094-1cd1-11ec-9621-0242ac130002","account_number":"245532345","routing_number":"4432343","existing_end_user_id":"eur_7985e8a4-8f38-4eab-8b27-a5d1c6dbf341","new_end_user_details":{"type":"INDIVIDUAL","first_name":"John","last_name":"Smith","organization":"DRUO","organization_legal_name":"DRUO Inc","local_id":"455235553","local_id_type":"NATIONAL_ID","local_id_country":"COL","email":"john.smith@druo.com","phone_number":{"country_code":"1","number":"3053053000"}}},"properties":{"uuid":{"type":"string","description":"The ID of the account used to fund this transaction."},"token":{"type":"string","description":"Token identifier."},"institution_uuid":{"type":"string","description":"The UUID of the Institution where the Connected Account is registered. Required if uuid and token are not provided."},"account_number":{"type":"string","description":"The account's number. Required if uuid and token are not provided."},"routing_number":{"type":"string","description":"The account's routing number, usually indicating where the account was opened."},"existing_end_user_id":{"type":"string","description":"The UUID of an existing End User to associate with this Transaction. Required if new_end_user_details is not present."},"new_end_user_details":{"type":"object","description":"Details of a new end user to create and associate with this transaction.","properties":{"type":{"type":"string","description":"The type of end user. Whether a company or an individual. Required if new_end_user_details is present."},"first_name":{"type":"string","description":"The user's first name. Required if type = INDIVIDUAL."},"last_name":{"type":"string","description":"The user's last name. Required if type = INDIVIDUAL."},"organization":{"type":"string","description":"The organization's name."},"organization_legal_name":{"type":"string","description":"The organization's legal name. Required if type = ORGANIZATION."},"local_id":{"type":"string","description":"The user's ID number. Required if local_id_country is COL."},"local_id_type":{"type":"string","description":"The user's ID type. Required if local_id_country is COL."},"local_id_country":{"type":"string","description":"The user's citizenship in a 3-letter ISO code. Required if local_id_country is COL."},"email":{"type":"string","description":"The user's email address."},"phone_number":{"type":"object","description":"The user's phone number details.","properties":{"country_code":{"type":"string","description":"The user's phone number's country code."},"number":{"type":"string","description":"The user's phone number without the country code."}}}}}}},"destination_account":{"type":"object","description":"The transaction's destination account details.","example":{"uuid":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340","token":"tok_e49f110e-804c-4e23-8e9c-4d4fae4c7868","institution_uuid":"ins_ff6c5094-1cd1-11ec-9621-0242ac130002","account_number":"245532345","routing_number":"4432343","existing_end_user_id":"eur_7985e8a4-8f38-4eab-8b27-a5d1c6dbf341","new_end_user_details":{"type":"INDIVIDUAL","first_name":"John","last_name":"Smith","organization":"DRUO","organization_legal_name":"DRUO Inc","local_id":"455235553","local_id_type":"NATIONAL_ID","local_id_country":"COL","email":"john.smith@druo.com","phone_number":{"country_code":"1","number":"3053053000"}}},"properties":{"uuid":{"type":"string","description":"The ID of the account used to fund this transaction."},"token":{"type":"string","description":"Token identifier."},"institution_uuid":{"type":"string","description":"The UUID of the Institution where the Connected Account is registered. Required if uuid and token are not provided."},"account_number":{"type":"string","description":"The account's number. Required if uuid and token are not provided."},"routing_number":{"type":"string","description":"The account's routing number, usually indicating where the account was opened."},"existing_end_user_id":{"type":"string","description":"The UUID of an existing End User to associate with this Transaction. Required if new_end_user_details is not present."},"new_end_user_details":{"type":"object","description":"Details of a new end user to create and associate with this transaction.","properties":{"type":{"type":"string","description":"The type of end user. Whether a company or an individual. Required if new_end_user_details is present."},"first_name":{"type":"string","description":"The user's first name. Required if type = INDIVIDUAL."},"last_name":{"type":"string","description":"The user's last name. Required if type = INDIVIDUAL."},"organization":{"type":"string","description":"The organization's name."},"organization_legal_name":{"type":"string","description":"The organization's legal name. Required if type = ORGANIZATION."},"local_id":{"type":"string","description":"The user's ID number. Required if local_id_country is COL."},"local_id_type":{"type":"string","description":"The user's ID type. Required if local_id_country is COL."},"local_id_country":{"type":"string","description":"The user's citizenship in a 3-letter ISO code. Required if local_id_country is COL."},"email":{"type":"string","description":"The user's email address."},"phone_number":{"type":"object","description":"The user's phone number details.","properties":{"country_code":{"type":"string","description":"The user's phone number's country code."},"number":{"type":"string","description":"The user's phone number without the country code."}}}}}}},"description":{"type":"string","description":"The description of this transaction. Users may see this description (e.g., in email receipts DRUO sends on your behalf).","example":"Insurance policy renewal - INV12324"},"statement_descriptor":{"type":"string","description":"Description that DRUO will report to institutions so that it appears on your customers' statements. This request may or may not be honored by the institutions. Must contain at least one letter, and be between 4 and 22 characters.","example":"NOVO BILLING* INV12324"},"amount":{"type":"integer","description":"The amount of money, in the smallest denomination of the currency indicated. For example, when currency is USD, the amount is represented in cents ($10.00 USD is 1000).","example":10000},"currency":{"type":"string","description":"The currency code in ISO 4217 format.","example":"USD"},"primary_reference":{"type":"string","description":"An optional primary ID you can associate with the transaction for your own purposes (such as to associate the transaction with an entity ID in your own database). This value cannot exceed 40 characters.","example":"ABC123"},"secondary_reference":{"type":"string","description":"An optional secondary ID you can associate with the transaction for your own purposes (such as to associate the transaction with an entity ID in your own database). This value cannot exceed 40 characters.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long.","example":{"order_id":"6735"}},"auto_send_receipt":{"type":"boolean","description":"If true, the system will generate a receipt automatically to the preferred receipt method.","example":false}},"required":["type","origin_account","destination_account","amount","currency"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The Transaction's UUID.","example":"trx_422f0f81-5001-4cce-a229-242d9ab9960a"},"code":{"type":"string","description":"The Transaction's code.","example":"TXNMW9PCWE"},"status":{"type":"string","description":"The Transaction's status.","enum":["PROCESSING","SUCCESSFUL","FAILED","CANCELED","REVERSED"],"example":"SUCCESSFUL"},"type":{"type":"string","description":"The type of Transaction.","example":"PAYMENT"},"tenant_id":{"type":"string","description":"The ID of the tenant that originated this transaction.","example":"ten_0521aadc-5fbd-4b3c-af0a-a4f4b8d6f20a"},"origin_account":{"type":"object","description":"The account details used to fund this transaction.","example":{"uuid":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"},"properties":{"uuid":{"type":"string","description":"The account's UUID."}}},"destination_account":{"type":"object","description":"The destination account details used in this transaction.","example":{"uuid":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"},"properties":{"uuid":{"type":"string","description":"The destination account's UUID."}}},"total_amount":{"type":"integer","description":"The total transaction amount, represented in the smallest denomination of the currency (e.g., cents for USD).","example":10000},"total_fee":{"type":"integer","description":"The total fee amount charged for this transaction.","example":400},"net_amount":{"type":"integer","description":"The total net amount (total_amount minus total_fee) to be paid for this transaction.","example":9600},"currency":{"type":"object","description":"The currency details for this transaction.","example":{"code":"USD"},"properties":{"code":{"type":"string","description":"The 3-letter ISO 4217 code of the currency."}}},"description":{"type":"string","description":"The description of this transaction.","example":"Insurance policy renewal - INV12324"},"statement_descriptor":{"type":"string","description":"Description that DRUO will report to institutions so that it appears on your customers' statements.","example":"NOVO BILLING* INV12324"},"primary_reference":{"type":"string","description":"An optional primary ID associated with the transaction for your own purposes.","example":"ABC123"},"secondary_reference":{"type":"string","description":"An optional secondary ID associated with the transaction for your own purposes.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"object","description":"Key-value pairs attached to the transaction.","example":{"order_id":"6735"}},"auto_send_receipt":{"type":"boolean","description":"If true, the system will automatically generate a receipt and send it to the preferred receipt method.","example":true},"date_created_gmt":{"type":"string","description":"The date and time the transaction was created (GMT).","example":"2021-11-15T23:23:38"},"date_updated_gmt":{"type":"string","description":"The date and time the transaction was last updated (GMT).","example":"2021-11-15T23:23:38"}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/transactions/authorize":{"post":{"operationId":"authorizeTransaction","summary":"Authorize Transaction","description":"Authorizes a transaction request. Initiates the authorization flow for a payment or transaction. This endpoint requires an Authorization Bearer Token to authenticate the user agent with the server and grant access to protected resources.","tags":["Acquirer Transactions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"custom_id":{"type":"string","description":"An optional custom identifier for this transaction.","example":"12345"},"type":{"type":"string","description":"The transaction type.","enum":["PAYMENT"],"example":"PAYMENT"},"tenant_id":{"type":"string","description":"The unique identifier of the tenant that originated the transaction.","example":"ten_0521aadc-5fbd-4b3c-af0a-a4f4b8d6f20a"},"origin_account":{"type":"object","description":"The origin account details from which the transaction is funded.","example":{"token":"tok_e49f110e-804c-4e23-8e9c-4d4fae4c7868"},"properties":{"uuid":{"type":"string","description":"The UUID of the account used to fund this transaction."},"token":{"type":"string","description":"The token representing the origin account."},"institution_uuid":{"type":"string","description":"The UUID of the institution where the account is registered. Required if uuid and token are not provided."},"account_number":{"type":"string","description":"The account number. Required if uuid and token are not provided."},"routing_number":{"type":"string","description":"The routing number of the financial institution."},"existing_end_user_id":{"type":"string","description":"The UUID of an existing end user to associate with this transaction. Required if new_end_user_details is not present."},"new_end_user_details":{"type":"object","description":"Details for creating a new end user to associate with this transaction.","properties":{"type":{"type":"string","description":"The type of end user (e.g., individual or company). Required if new_end_user_details is present.","enum":["INDIVIDUAL","ORGANIZATION"]},"first_name":{"type":"string","description":"The end user's first name. Required if type is INDIVIDUAL."},"last_name":{"type":"string","description":"The end user's last name. Required if type is INDIVIDUAL."},"organization":{"type":"string","description":"The organization's name."},"organization_legal_name":{"type":"string","description":"The organization's legal name. Required if type is ORGANIZATION."},"local_id":{"type":"string","description":"The user's local identification number. Required if local_id_country is COL."},"local_id_type":{"type":"string","description":"The user's local identification type. Required if local_id_country is COL."},"local_id_country":{"type":"string","description":"The user's identification country code in 3-letter ISO format. Required if country is COL."},"email":{"type":"string","description":"The user's email address."},"phone_number":{"type":"object","description":"The user's phone number details.","properties":{"country_code":{"type":"string","description":"The country code for the phone number."},"number":{"type":"string","description":"The phone number without the country code."}}}}}}},"destination_account":{"type":"object","description":"The destination account details receiving the transaction funds.","example":{"uuid":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"},"properties":{"uuid":{"type":"string","description":"The unique identifier of the destination account."},"token":{"type":"string","description":"The token representing the destination account."},"institution_uuid":{"type":"string","description":"The UUID of the institution where the destination account is registered. Required if uuid and token are not provided."},"account_number":{"type":"string","description":"The destination account number. Required if uuid and token are not provided."},"routing_number":{"type":"string","description":"The routing number of the destination financial institution."},"existing_end_user_id":{"type":"string","description":"The UUID of an existing end user to associate with this transaction. Required if new_end_user_details is not present."},"new_end_user_details":{"type":"object","description":"Details for creating a new end user to associate with this destination account.","properties":{"type":{"type":"string","description":"The type of end user (e.g., individual or company). Required if new_end_user_details is present.","enum":["INDIVIDUAL","ORGANIZATION"]},"first_name":{"type":"string","description":"The end user's first name. Required if type is INDIVIDUAL."},"last_name":{"type":"string","description":"The end user's last name. Required if type is INDIVIDUAL."},"organization":{"type":"string","description":"The organization's name."},"organization_legal_name":{"type":"string","description":"The organization's legal name. Required if type is ORGANIZATION."},"local_id":{"type":"string","description":"The user's local identification number. Required if local_id_country is COL."},"local_id_type":{"type":"string","description":"The user's local identification type. Required if local_id_country is COL."},"local_id_country":{"type":"string","description":"The user's identification country code in 3-letter ISO format. Required if country is COL."},"email":{"type":"string","description":"The user's email address."},"phone_number":{"type":"object","description":"The user's phone number details.","properties":{"country_code":{"type":"string","description":"The country code for the phone number."},"number":{"type":"string","description":"The phone number without the country code."}}}}}}},"description":{"type":"string","description":"An optional description for this transaction. This description may be visible to end users (e.g., in email receipts).","example":"Insurance policy renewal - INV12324"},"statement_descriptor":{"type":"string","description":"The transaction statement descriptor reported to financial institutions. Must contain at least one letter and be between 4 and 22 characters.","example":"NOVO BILLING* INV12324"},"amount":{"type":"integer","description":"The transaction amount, specified in the smallest currency denomination (e.g., cents for USD).","example":10000},"currency":{"type":"string","description":"The three-letter ISO 4217 currency code.","example":"USD"},"primary_reference":{"type":"string","description":"An optional primary identifier for associating the transaction with your own internal database. Maximum of 40 characters.","example":"ABC123"},"secondary_reference":{"type":"string","description":"An optional secondary identifier for associating the transaction with your own internal database. Maximum of 40 characters.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"object","description":"Key-value pairs for attaching custom metadata. Supports up to 50 keys, with key names up to 40 characters and values up to 500 characters.","example":{"order_id":"6735"}},"auto_send_receipt":{"type":"boolean","description":"If true, automatically generates and sends a receipt to the preferred receipt channel.","example":false}},"required":["type","origin_account","destination_account","amount","currency"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The transaction's unique identifier.","example":"trx_422f0f81-5001-4cce-a229-242d9ab9960a"},"code":{"type":"string","description":"The transaction's human-readable tracking code.","example":"TXNMW9PCWE"},"status":{"type":"string","description":"The current status of the transaction.","enum":["PROCESSING","SUCCESSFUL","FAILED","CANCELED","REVERSED"],"example":"SUCCESSFUL"},"type":{"type":"string","description":"The type of transaction.","example":"PAYMENT"},"tenant_id":{"type":"string","description":"The unique identifier of the tenant that initiated the transaction.","example":"ten_0521aadc-5fbd-4b3c-af0a-a4f4b8d6f20a"},"origin_account":{"type":"object","description":"The origin account details used to fund the transaction.","example":{"uuid":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"},"properties":{"uuid":{"type":"string","description":"The unique identifier of the origin account."}}},"destination_account":{"type":"object","description":"The destination account details receiving the transaction funds.","example":{"uuid":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"},"properties":{"uuid":{"type":"string","description":"The unique identifier of the destination account."}}},"total_amount":{"type":"integer","description":"The total transaction amount in the smallest currency denomination.","example":10000},"total_fee":{"type":"integer","description":"The total fee amount charged for this transaction in the smallest currency denomination.","example":400},"net_amount":{"type":"integer","description":"The total net amount (total_amount minus total_fee) in the smallest currency denomination.","example":9600},"currency":{"type":"object","description":"The currency details.","example":{"code":"USD"},"properties":{"code":{"type":"string","description":"The three-letter ISO 4217 currency code."}}},"description":{"type":"string","description":"The description of this transaction.","example":"Insurance policy renewal - INV12324"},"statement_descriptor":{"type":"string","description":"The statement descriptor reported to financial institutions.","example":"NOVO BILLING* INV12324"},"primary_reference":{"type":"string","description":"An optional primary internal identifier.","example":"ABC123"},"secondary_reference":{"type":"string","description":"An optional secondary internal identifier.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"object","description":"The key-value metadata pairs attached to the transaction.","example":{"order_id":"6735"}},"auto_send_receipt":{"type":"boolean","description":"Indicates whether a receipt was automatically generated and sent.","example":true},"date_created_gmt":{"type":"string","description":"The GMT timestamp when the transaction was created.","example":"2021-11-15T23:23:38"},"date_updated_gmt":{"type":"string","description":"The GMT timestamp when the transaction was last updated.","example":"2021-11-15T23:23:38"}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/transactions/validate":{"put":{"operationId":"validateTransaction","summary":"Validate Transaction","description":"Validate a transaction. Validates a transaction using a transaction UUID and validation token or OTP. Requires a Bearer Token for authentication.","tags":["Acquirer Transactions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"custom_id":{"type":"string","description":"An idempotency key used to prevent duplicate operations.","example":"ten_0521aadc-5fbd-4b3c-af0a-a4f4b8d6f20a"},"token":{"type":"string","description":"The validation token identifier.","example":"tok_e49f110e-804c-4e23-8e9c-4d4fae4c7868"},"transaction_uuid":{"type":"string","description":"The unique identifier (UUID) of the transaction.","example":"trx_422f0f81-5001-4cce-a229-242d9ab9960a"},"otp_value":{"type":"string","description":"The one-time password (OTP) required to validate this transaction.","example":"<otp_value>"}},"required":["token","transaction_uuid"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier (UUID) of the transaction.","example":"trx_422f0f81-5001-4cce-a229-242d9ab9960a"},"status":{"type":"string","description":"The current status of the transaction.","enum":["PROCESSING","SUCCESSFUL","FAILED","CANCELED"],"example":"SUCCESSFUL"},"decline_reason":{"type":"string","description":"The decline reason for the transaction, if applicable.","example":"INSUFFICCIENT_FUNDS"}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/transactions/{transaction_uuid}":{"get":{"operationId":"getTransaction","summary":"Get Transaction","description":"Retrieve the details of an existing transaction. Returns full details of a specific transaction using its unique UUID. This endpoint requires an Authorization Bearer Token for credentials authentication.","tags":["Acquirer Transactions"],"parameters":[{"name":"transaction_uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier of the transaction.","example":"trx_422f0f81-5001-4cce-a229-242d9ab9960a"},"code":{"type":"string","description":"The transaction's unique code.","example":"TXNMW9PCWE"},"status":{"type":"string","description":"The current status of the transaction.","enum":["CREATED","PENDING","PROCESSING","SUCCESSFUL","REFUNDED","DISPUTED","FAILED","CANCELED","REVERSED"],"example":"SUCCESSFUL"},"remarks":{"type":"string","description":"Notes or remarks concerning the transaction status.","example":"REQUESTED_BY_MERCHANT"},"type":{"type":"string","description":"The transaction type.","example":"PAYMENT"},"tenant":{"type":"object","description":"The tenant details that originated the transaction.","example":{"uuid":"ten_0521aadc-5fbd-4b3c-af0a-a4f4b8d6f20"}},"origin_account":{"type":"object","description":"The account used to fund this transaction.","example":{"uuid":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"}},"destination_account":{"type":"object","description":"The account receiving the funds for this transaction.","example":{"uuid":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"}},"creation_source":{"type":"string","description":"The platform or interface from which the transaction was created.","example":"MERCHANT_PORTAL"},"description":{"type":"string","description":"An arbitrary description of the transaction. This description may be visible to end users, such as in email receipts.","example":"Insurance policy renewal - INV12324"},"statement_descriptor":{"type":"string","description":"The text display on your customer's bank statement. This value must contain at least one letter and be between 4 and 22 characters.","example":"NOVO BILLING* INV12324"},"amount":{"type":"integer","description":"The amount of the transaction in the smallest denomination of the currency (e.g., cents for USD).","example":10000},"variable_fee":{"type":"integer","description":"The variable fee amount applied to this transaction, in the smallest denomination.","example":300},"fixed_fee":{"type":"integer","description":"The fixed fee amount applied to this transaction, in the smallest denomination.","example":100},"total_fee":{"type":"integer","description":"The combined fixed and variable fee amounts, in the smallest denomination.","example":400},"net_amount":{"type":"integer","description":"The net amount (amount minus total_fee) to be settled for this transaction, in the smallest denomination.","example":9600},"currency":{"type":"object","description":"The currency represented in ISO 4217 format.","example":{"code":"USD"}},"primary_reference":{"type":"string","description":"An optional tracking identifier associated with this transaction. Maximum 40 characters.","example":"ABC123"},"secondary_reference":{"type":"string","description":"An optional secondary tracking identifier associated with this transaction. Maximum 40 characters.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"object","description":"A set of custom key-value pairs attached to the transaction object. Supports up to 50 keys, with key names up to 40 characters and values up to 500 characters.","example":{"order_id":"6735"}},"auto_send_receipt":{"type":"boolean","description":"Determines if the system will automatically send a transaction receipt to the customer's preferred delivery method.","example":false},"date_created_gmt":{"type":"string","description":"The date and time when the transaction was created (GMT).","example":"2021-11-15T23:23:38"},"date_updated_gmt":{"type":"string","description":"The date and time when the transaction was last updated (GMT).","example":"2021-11-15T23:23:38"}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/transactions/list":{"get":{"operationId":"listTransactions","summary":"List Transactions","description":"Retrieve a list of all transactions. Returns a list of all existing transactions. Requires an Authorization Bearer token to authenticate and access the resource.","tags":["Acquirer Transactions"],"parameters":[{"name":"page","in":"query","required":false,"description":"The page number to return. Starts at 1.","schema":{"type":"integer"}},{"name":"page_size","in":"query","required":false,"description":"The number of items per page. Defaults to 1000 when omitted.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","description":"The transaction's unique identifier (UUID).","example":"trx_422f0f81-5001-4cce-a229-242d9ab9960a"},"code":{"type":"string","description":"The transaction's reference code.","example":"TXNMW9PCWE"},"status":{"type":"string","description":"The current status of the transaction.","enum":["CREATED","PENDING","PROCESSING","SUCCESSFUL","REFUNDED","DISPUTED","FAILED","CANCELED","REVERSED"],"example":"SUCCESSFUL"},"remarks":{"type":"string","description":"Additional remarks or notes about the transaction.","example":"REQUESTED_BY_MERCHANT"},"type":{"type":"string","description":"The type of transaction.","example":"PAYMENT"},"tenant":{"type":"object","description":"The tenant that originated the transaction.","example":{"uuid":"ten_0521aadc-5fbd-4b3c-af0a-a4f4b8d6f20"}},"origin_account":{"type":"object","description":"The account used to fund this transaction.","example":{"uuid":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"}},"destination_account":{"type":"object","description":"The account that receives the funds for this transaction.","example":{"uuid":"acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340"}},"creation_source":{"type":"string","description":"The source platform or channel through which the transaction was created.","example":"MERCHANT_PORTAL"},"description":{"type":"string","description":"The description of this transaction. Users may see this on receipts or emails sent by DRUO.","example":"Insurance policy renewal - INV12324"},"statement_descriptor":{"type":"string","description":"The description reported to financial institutions to appear on customer statements. This request may not be honored by all institutions. It must contain at least one letter and be between 4 and 22 characters.","example":"NOVO BILLING* INV12324"},"amount":{"type":"integer","description":"The transaction amount, denominated in the smallest unit of the currency (e.g., cents for USD). For example, $100.00 USD is represented as 10000.","example":10000},"variable_fee":{"type":"integer","description":"The variable fee amount applied to this transaction.","example":300},"fixed_fee":{"type":"integer","description":"The fixed fee amount applied to this transaction.","example":100},"total_fee":{"type":"integer","description":"The total fee amount charged for this transaction.","example":400},"net_amount":{"type":"integer","description":"The total net amount (amount minus total_fee) to be paid out for this transaction.","example":9600},"currency":{"type":"object","description":"The transaction currency represented in ISO 4217 format.","example":{"code":"USD"}},"primary_reference":{"type":"string","description":"An optional primary identifier you can associate with the transaction for your own database tracking. Maximum 40 characters.","example":"ABC123"},"secondary_reference":{"type":"string","description":"An optional secondary identifier you can associate with the transaction. Maximum 40 characters.","example":"bj39fhow39fhqp3f0hfae4344"},"metadata":{"type":"object","description":"A set of key-value pairs that you can attach to the object. You can specify up to 50 keys, with key names up to 40 characters and values up to 500 characters.","example":{"order_id":"6735"}},"auto_send_receipt":{"type":"boolean","description":"Indicates whether the system should automatically generate a receipt to the preferred delivery method.","example":false},"date_created_gmt":{"type":"string","description":"The date and time the transaction was created, in GMT.","example":"2021-11-15T23:23:38"},"date_updated_gmt":{"type":"string","description":"The date and time the transaction was last updated, in GMT.","example":"2021-11-15T23:23:38"}}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/transactions/cancel":{"put":{"operationId":"cancelTransaction","summary":"Cancel Transaction","description":"Cancels a pending or active transaction. Cancels an in-progress transaction using its unique transaction UUID and token. This endpoint requires Bearer Token authentication.","tags":["Acquirer Transactions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"custom_id":{"type":"string","description":"An idempotency key created to prevent double-processing of the cancellation request.","example":"ten_0521aadc-5fbd-4b3c-af0a-a4f4b8d6f20a"},"token":{"type":"string","description":"The unique identifier of the payment token.","example":"tok_e49f110e-804c-4e23-8e9c-4d4fae4c7868"},"transaction_uuid":{"type":"string","description":"The unique identifier of the transaction to cancel.","example":"trx_422f0f81-5001-4cce-a229-242d9ab9960a"}},"required":["token","transaction_uuid"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier of the transaction.","example":"trx_422f0f81-5001-4cce-a229-242d9ab9960a"},"status":{"type":"string","description":"The current status of the transaction.","enum":["PROCESSING","SUCCESSFUL","FAILED","CANCELED"],"example":"SUCCESSFUL"},"decline_reason":{"type":"string","description":"The reason why the transaction was declined, if applicable.","example":"INSUFFICCIENT_FUNDS"}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/transactions/refund":{"put":{"operationId":"refundTransaction","summary":"Refund Transaction","description":"Refunds a transaction. Initiates a refund for a previously processed transaction. This endpoint requires Bearer Token authentication to authorize access to the protected transaction resource.","tags":["Acquirer Transactions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"custom_id":{"type":"string","description":"An idempotency key created to enable safe retries of operations.","example":"ten_0521aadc-5fbd-4b3c-af0a-a4f4b8d6f20a"},"token":{"type":"string","description":"The unique token identifier for the payment source.","example":"tok_e49f110e-804c-4e23-8e9c-4d4fae4c7868"},"transaction_uuid":{"type":"string","description":"The unique identifier (UUID) of the transaction to be refunded.","example":"trx_422f0f81-5001-4cce-a229-242d9ab9960a"}},"required":["token","transaction_uuid"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier (UUID) of the refund transaction.","example":"trx_422f0f81-5001-4cce-a229-242d9ab9960a"},"status":{"type":"string","description":"The current status of the transaction.","enum":["PROCESSING","SUCCESSFUL","FAILED","CANCELED"],"example":"SUCCESSFUL"},"decline_reason":{"type":"string","description":"The reason why the transaction was declined, if applicable.","example":"INSUFFICCIENT_FUNDS"}}}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"OAuth 2.0 client-credentials token from POST https://auth.druo.com/oauth/token"}},"responses":{"Error":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"code":{"type":"string"},"detail":{"type":"string"},"field":{"type":"string"}}}}}}}}}}}}