{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"8e5dfa28-ac73-48bb-853e-2a01b641fb08","name":"Buckzy API collection","description":"Welcome to our developer community!\n\nBuckzy platform has been designed with a rich set of APIs that enables our partners and customers to develop cross-border payment solutions. Whether you’re developing a custom solution or building a mobile App for the App Marketplace, our developer platform has the tools and capabilities to support you.\n\nBegin the integration process with Buckzy by reviewing this document to understand the API structures and capabilities available.\n\nOnce you’ve familiarized yourself with the details, gain access to our SANDBOX environment. With SANDBOX access, you’re ready to start the development process and integrate with Buckzy.\n\n# <u>How to use this Guide?</u>\n\nThis guide is designed to help you navigate and effectively use our API collection for your application. It walks you through the core concepts and the structure of the Buckzy APIs, enabling you to build seamless integrations with our platform.\n\n#### 1\\. **Exploring Endpoints**\n\nThe endpoints are listed in the left sidebar. Each folder is clearly labeled, and contains all the endpoints required for that particular functionality. To find the ones related to a specific feature, simply navigate into each folder.\n\n<img src=\"https://content.pstmn.io/1ba8824c-3f86-43f1-9600-e9bbe601f3b3/aW1hZ2UucG5n\" width=\"256\" height=\"301\">\n\n#### 2\\. **Viewing Use Cases - Request and Response Payloads**\n\nEach endpoint, has multiple use case examples added to help you understand the different scenarios in which the endpoint can be used. To view the use case examples:\n\n- Click on the **dropdown** next to the **Example** **Request** label.\n    \n- This will reveal the different use case examples, along with the associated request and response payloads.\n    \n\nEach use case includes:\n\n- **Request Payload**: The data that should be sent to the API for that specific use case.\n    \n- **Response Payload**: The expected response from the API, which includes status codes, data structure, and other relevant details.\n    \n\nClick on the desired use case to see the request and response data, then you can modify or test the payload as needed.\n\nRefer to the **ADDITIONAL INFORMATION** section for different reference codes used in the paylods.\n\n<img src=\"https://content.pstmn.io/af0d423a-04b0-48f5-9749-fbc600e93da0/aW1hZ2UucG5n\" width=\"1005\" height=\"695\">\n\n#### **3\\. Accessing the API Collection**\n\nClick on \"**Run in Postman**\" button at the top right corner to add the collection to your workspace.\n\n#### **4\\. Testing the Endpoints**\n\nOnce you have selected a use case and reviewed the payloads, you can send the request directly from Postman to test the endpoint. The response will be shown within the Postman interface, allowing you to verify the behavior of the API.\n\n**Feel free to experiment with different use cases, and don’t hesitate to reach out if you need further assistance!**\n\n# <u>Use Cases</u>\n\nHere are the key use cases we offer, covering a range of payment types and transaction methods:\n\n- **Single Payment (Payout)**\n    \n    - **B2B (Business to Business)**: Both the sender and receiver are businesses.\n        \n    - **B2C (Business to Consumer)**: The sender is a business, and the receiver is an individual.\n        \n    - **C2C (Consumer to Consumer)**: Both the sender and receiver are individuals.\n        \n    - **C2B (Consumer to Business)**: The sender is an individual, and the receiver is a business.\n        \n- **Payout with Different Payment Methods**\n    \n    - Supports various payment methods such as **Wire**, **ACH**, **Fedwire**, **SEPA**, **FPS**, **IMPS**, and **UPI**.\n        \n- **Account to Account Transfer (A2A)**\n    \n    - Facilitates direct transfers between accounts.\n        \n- **Mass Payment**\n    \n    - Enables processing of bulk payments.\n        \n- **Payin (Inbound Transaction)**\n    \n    - **Payin with PIX (BR) -** Supports transactions using **PIX**, a real-time payment system in Brazil.\n        \n\n# <u>Webhook</u>\n\nYou can receive notifications (callbacks) whenever the status of a transaction changes during processing. To enable this feature, simply provide Buckzy with the callback URL you’d like to use. This URL is usually provided during the onboarding process.\n\nEach time a transaction’s status changes, Buckzy will send a POST JSON request to the specified URL. The request body will include the same fields as those returned when initiating or retrieving a transaction.\n\n**Callback Payload:**\n\n```\n{\n  \"transactionId\": \"01ba7dd6-0916-4b1e-8b52-3c5ddb3823f0\",\n  \"instructionId\": \"12123123123123\",\n  \"status\": {\n    \"status\": \"AcceptedSettlementCompleted\",\n    \"reasonCode\": \"0000\",\n    \"reasonDescription\": \"Completed successfully\"\n  },\n  \"direction\": \"Inbound\",\n  \"authCode\": null,\n  \"clientId\": \"TEST_CLIENTID\"\n}\n\n ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"34644703","team":2561102,"collectionId":"8e5dfa28-ac73-48bb-853e-2a01b641fb08","publishedId":"2sAYQfC8a5","public":true,"publicUrl":"https://docs-api.buckzy.net","privateUrl":"https://go.postman.co/documentation/34644703-8e5dfa28-ac73-48bb-853e-2a01b641fb08","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":"This document guides you through the core concepts used to structure API. Understanding the Buckzy APIs and underlying data elements will make it easier to build integrations with our platform."},{"name":"title","value":"Buckzy API Documentation"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.0","publishDate":"2025-02-03T22:14:23.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Buckzy API Documentation","description":"This document guides you through the core concepts used to structure API. Understanding the Buckzy APIs and underlying data elements will make it easier to build integrations with our platform."},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/8c922b5b0e67eb0d88a4fadd9fdd874ebc9321eacdab24777c918ac87539d449","favicon":"https://buckzy.net/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://docs-api.buckzy.net/view/metadata/2sAYQfC8a5"}