Welcome to AnSpacePay API!
In this documentation, you will find all the information on integrating with our API.
You can easily integrate withdrawal and deposit functions in your application, offering your customers a secure and reliable transaction experience.
In the production environment, calls must be made using the HTTPS protocol.
\nToken - responsible for generating the token used in all requests.
\nDeposit - In case of a deposit, our customers must call the PaymentPix API.
\nWithdraw - In case of withdrawal, our customers must call the TransferPix API.
\nWebhook - You can check the callback process of deposit and withdrawal methods.
\nYou can download our collection to your local environment by clicking on the \"Run in Postman\" button in the upper right corner of the screen.
\nYou can use both Postman Web and Postman Desktop.
\nBefore making any request, it is necessary to authenticate through the Token endpoint. Token[POST -> Token]
\nTo connect with our API in the production environment, it is necessary to inform your IP so that it is released by our firewall. In a SANDBOX environment, it is not necessary.
\nOutgoing IPs from which AnSpace can make calls to the partners' API.
\nProduction
\n3.217.158.141
100.24.146.217
54.235.243.113
35.174.203.128
44.206.203.196
54.207.112.29
Homologation
3.223.125.52
Sandbox
44.198.72.58
Use of deposit methods
\nIn case of a deposit, our customers must call the PaymentPix API.
\nPrecondition
\n- Generation of the access token through the Token folder (Token[POST -> Token])
\nRequest:
\n- After generating the token, access a mass deposit, PaymentPix endpoint:
\nHeaders:
\nApplicationToken – (Obtained from the Customer Panel integration registration screen.)
\nAuthorization - (Bearer + access_token)
\nX-Request-Id -
\nOptional parameter where the customer can enter a hash code at the time of deposit.
\nThe value informed in the x-request-id parameter will be encrypted using the applicationtoken as key.
The method used for encryption is the HMAC-SHA256 passing two parameters, the first being the value of the x-request-id, and the second the value that comes in the Applicationtoken parameter.
You can use the site https://www.devglan.com/online-tools/hmac-sha256-online to encrypt your token.
\nThis parameter will be used in callback control on successful operations.
\nThe x-request-id parameter will be sent in the header of the callback function.
\nThis field supports values of up to 68 characters.
\nBody:
\n{\n \"CustomId\": \"\",\n \"amount\": 100,\n \"dueDate\": \"30/12/2023\",\n \"customer\": {\n \"name\": \"SANDBOX PEOPLE NAME\",\n \"phoneNumber\": \"+12345678910121314\",\n \"email\": \"sandbox.people@email.sandbox.com\",\n \"cpfcnpj\": \"87397163769\",\n \"bankispb\":\"000000\",\n \"bankbranch\":\"00000\",\n \"bankaccount\":\"00000\",\n \"address\": \"STREET 01, NUMBER 02 - HOUSE 03\",\n \"neighborhood\": \"NEIGHBORHOOD\",\n \"city\": \"CITY\",\n \"state\": \"UF\",\n \"country\": \"BRAZIL\",\n \"zipcode\": \"12345678\"\n },\n \"ExpirationInMinutes\": \"6\",\n \"confirmationUrl\": \"https://webhook.site/495472fc-207d-45ae-8c5d-731ec32779d4\"\n}\n\nBank details:
\nAdditional information for the deposit process.
\nbankispb (optional): ISPB code of the user's bank.
bankbranch (optional): User's bank branch number.
bankaccount (optional): User's bank account number, without the hyphen, but including the check digit.
In case of success, confirmation of a deposit is carried out by confirmationUrl
\nAfter making the request, our system will return to the Status Code 200 customer with the payment QRCode.
At this time, our system will be waiting for the payment. In case of identified payment, we carry out the processing, confirm, and send Callback to the customer.
After sending the Callback to the client, we expect the client to return with the code 200 in case of Success. Having content in the body is unnecessary, as we only validate the Status Code.
\nIf it returns Status Code 400, our system understands that it is critical for the customer's system and in this case, our system will consider it as sent.
\nFor any code different from 200 and 400, our system will try to send the shipment 20 times, if not successful, our system will finish the shipment. If any callback is missed by the customer our support department can be contacted to resend the webhooks.
\nIn case of non-payment of the QRCode, we do not have Callback communication.
\nPending
\nCanceled
\nPaid
\nOverdue
\nUse of the Withdrawal method
\nIn case of withdrawal, our customers must call the TransferPix API.
\nPrecondition:
\n- Generation of the access token through the Token folder (Token[POST -> Token])
\nRequisition:
\n- After generating the token, access the Withdraw endpoint TransferPix folder:
\nHeaders:
\nApplicationToken – (Obtained from the Customer Panel integration registration screen.)
\nAuthorization - (Bearer + access_token)
\nx-request-id (
\nOptional parameter where the customer can enter a hash code at the time of withdrawal.
\nThe value informed in the x-request-id parameter will be encrypted using the applicationtoken as key.
The method used for encryption is the
HMAC-SHA256 passes two parameters, the first being the value of the x-resquest-id, and the second being the value of the Applicationtoken parameter.
You can use the site https://www.devglan.com/online-tools/hmac-sha256-online to encrypt your token.
\nThis parameter will be used in callback control on successful operations.
\nThe x-request-id parameter will be sent in the header of the callback function.
\nThis field supports values of up to 68 characters.
\nBody:''
\n\"digitalSignature\": \"\",\n\"amount\": 1,\n\"favorecido\": {\n \"nome\": \"SANDBOX PEOPLE NAME\",\n \"cpfcnpj\": \"87397163769\",\n \"chave\": {\n \"idTipoChavePIX\": 1,\n \"chavePIX\": \"87397163769\"\n },\n \"bankispb\":\"000000\",\n \"bankbranch\":\"00000\",\n \"bankaccount\":\"00000\"\n},\n\"confirmationUrl\": \"https://webhook.site/495472fc-207d-45ae-8c5d-731ec32779d4\",\n\"updateUrl\": \"https://webhook.site/bd2f10b5-daa1-4980-87c5-50d38b182a36\"\n\n**
Bank details**:
Additional information for the withdrawal process.
\nbankispb (optional): ISPB code of the user's bank.
bankbranch (optional): User's bank branch number.
bankaccount (optional): User's bank account number, without the hyphen, but including the check digit.
Optional information:**
\nIn case of success, confirmation of a withdraw is carried out by confirmationUrl. In the event of a reversal, it will be carried out exclusively through the updateUrl.
\nSuccessful payment
\nAfter we receive the withdrawal request and process it asynchronously and wait for the bank to return, if the bank confirms it, we send a Callback confirming the withdrawal. The expected code for them is 200 can be content.
\nIf it returns Status code 400, our system understands that it is critical to the client's system and in this case, our system considers it as sent.
\nFor anything other than 200 and 400, our system will try to send the submission 20 times, if unsuccessful, our system will terminate the submission attempt. If any callback is missed by the customer our support department can be contacted to resend the webhooks.
\nPayment instability:
\nWe received the withdrawal request and processed it asynchronously and waited for the bank to return. If the bank returns that it was unable to pay, for example (Destination institution rejected payment, origin institution rejected payment, unstable central bank or other reasons) we return the instability codes:
\n**
Withdraw:**
01 - INSTABILITY
\n02 - RETURNED TRANSACTION
\n03 - REJECTED TRANSACTION
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Download the collection","slug":"download-the-collection"},{"content":"About Authorization","slug":"about-authorization"},{"content":"About IP Authorization","slug":"about-ip-authorization"},{"content":"IPs from AnSpace","slug":"ips-from-anspace"},{"content":"About Deposit","slug":"about-deposit"},{"content":"About Withdraw","slug":"about-withdraw"}],"owner":"34318601","collectionId":"4467063e-d78b-4b7b-a8ac-c9aa338213c9","publishedId":"2sAY545JZ5","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-11-11T20:23:59.000Z"},"item":[{"name":"Security Headers","item":[],"id":"61e133e1-9c96-40bb-b886-24cbd554f54c","description":"Goal:
\nThis manual aims to establish the Security Headers that must be implemented by default for WEB applications.
\nThe OWASP Top 10 is a list of the top ten most critical security vulnerabilities in web applications, compiled by the Open Web Application Security Project (OWASP). This best practices guide focuses on HTTP headers to increase application security, considering the risks identified in the OWASP Top 10.
\nScope:
\nThis manual is applicable to all WEB applications in the AnSpace Pay environment.
\nGuidelines:
\nIn accordance with our Vulnerability Management process, we use the Tenable.io Web App Scanning tool, which is one of the leading tools for tracking scans.
Therefore, we used the HTTP Security Header Family plugin as a base to determine the criticality and necessity of implementing Security Headers.
Security Headers and Mandatory Recommendations:
\nBased on criticality, the following Security Headers are mandatory:
\nHTTP Strict Transport Security HSTS:
\nThis header, for security reasons and compliance with scans, must include the value of max-age=31536000 ; includeSubDomains
More information can be consulted on the reference pages below:
Cross-Origin Resource Sharing CORS:
\nThis header, for security reasons and compliance with scans, must include the mapping of all domains that interact with the request, otherwise the scan points to an insecure configuration.
\nMore information can be consulted on the reference pages below:
\n\nContent Security Policy CSP
\nThis header allows control over the resources the user agent is allowed to load for a given page, essential to prevent scripting attacks.
More information can be consulted on the reference pages below:
Content-Type
\nThis header allows clients to find the best way to render application data.
More information can be consulted on the reference pages below:
Missing 'Content-Type' Header | Tenable®
\nCache-Control:
\nThis header is used to specify directives for caching mechanisms. It is essential to use the correct directives based on the context of the page, in order to prevent sensitive information (such as passwords, credit cards and personal information) from being stored on the client side and, consequently, from being intercepted by unauthorized persons. authorized.
More information can be consulted on the reference pages below:
Missing 'Cache-Control' Header | Tenable®
X-Content-Type-Options:
\nThis header is a marker used by the server to indicate that the MIME types sent by the Content-:Type headers should not be altered or followed.
More information can be consulted on the reference pages below:
X-Content-Type-Options - HTTP | MDN (mozilla.org)
X-Frame-Options
\nThis header is used to indicate whether or not the browser should render the page in a (en-US), , or (en-US). Sites can use this to prevent click-jacking attacks by ensuring that their content is not embedded on other sites.
More information can be consulted on the reference pages below:
Missing 'X-Frame-Options' Header | Tenable®
HTTP Header Information Disclosure
\nThis information is not a specific header, but an information security recommendation to disable default headers that indicate server information, an attacker can use this information to take advantage of specific vulnerabilities.
More information can be consulted on the reference pages below:
HTTP Header Information Disclosure | Tenable®
HTTP user-Agent:
\nIn summary, the User-Agent header can provide useful information about the client accessing the application, but it should be treated with caution. Validate and sanitize User-Agent data and monitor logs for suspicious activity. Don't base security decisions solely on User-Agent and implement other comprehensive security practices to secure your application.
More information can be consulted on the reference pages below:
User-Agent Header (tenable.com)
Revision:
\nThis standard is reviewed annually or as understood by the Information Security manager.
\n","_postman_id":"61e133e1-9c96-40bb-b886-24cbd554f54c"},{"name":"Token","item":[{"name":"Token","id":"8a831d73-d555-4f9a-bac3-52814313ee49","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"username","value":"190626000001","type":"text"},{"key":"password","value":"21abd94c-d2a5-48ba-b38d-4a38752e8772","type":"text"},{"key":"grant_type","value":"password","type":"text"}]},"url":"https://sandbox.api.anspacepay.com/token","description":"In order to have access to ALL API Methods, it is necessary to request a TOKEN that will be valid for 1h (one hour). To obtain this TOKEN, the user and password of each application created in the Digital Infinity panel will be used.
\nREQUEST :
\nRESPONSE :
\nREQUEST IDENTIFICATION
\nAll API methods need to be identified and linked to a client application. For each application created in your panel, an “applicationtoken” is generated. This code must be sent in the header of each request, as well as the authentication token obtained as described above.
\n","urlObject":{"path":["token"],"host":["https://sandbox.api.anspacepay.com"],"query":[],"variable":[]}},"response":[{"id":"6c98137e-dee4-4af6-b197-326a5418eb54","name":"Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","name":"Content-Type","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"username","value":"190626000001","type":"text"},{"key":"password","value":"21abd94c-d2a5-48ba-b38d-4a38752e8772","type":"text"},{"key":"grant_type","value":"password","type":"text"}]},"url":"https://sandbox.api.anspacepay.com/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Type","value":"application/json;charset=UTF-8","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/10.0","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true},{"key":"Date","value":"Sun, 26 Mar 2023 13:33:10 GMT","enabled":true},{"key":"Content-Length","value":"294","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"EPMgRea0lIVFDOnP-Is2720XbnzsFAc8E8QZZHGMTUlZ6z122BRvZt61binC57qQarhp9JIka0xywBmn1DWlWLd1U85L0JeQDHuwmnB6GR9-NHE6-qq80V9sEBp0Ukvn1vfZiojeCeP51wb6gHT_E89DnBiqXheSzYKKiu5dvNPZyY_IFPL3u1-PyIgWb-YxZe6LO5vWtTQEpzCZ2WFUyrZaDtpb8aWdT854kUxlS4I\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3599\n}"}],"_postman_id":"8a831d73-d555-4f9a-bac3-52814313ee49"}],"id":"7b7f9afb-153f-40e3-8415-e1131312c206","_postman_id":"7b7f9afb-153f-40e3-8415-e1131312c206","description":""},{"name":"PIX","item":[{"name":"Deposit","item":[{"name":"PaymentPix","event":[{"listen":"prerequest","script":{"id":"6330e24a-87d1-43bf-903b-77dd9240646b","exec":["var Atual = new Date()\r","var customId = Number(Atual)\r","pm.collectionVariables.set('CustomId', customId)\r","\r","//Checa se as variaveis obrigatorias estao preenchidas\r","if (!pm.collectionVariables.get('USRENAME-SANDBOX') || !pm.collectionVariables.get('PWD-SANDBOX')){\r"," throw new Error('Usuario ou senha em branco')\r","}\r","if (!pm.collectionVariables.get('TOKEN-SANDBOX')){\r"," throw new Error('ApplicationToken em branco')\r","}\r","pm.sendRequest({\r"," url: pm.collectionVariables.get('SANDBOX') + '/token',\r"," method: 'POST',\r"," header: {'content-type': 'application/x-www-form-urlencoded'},\r"," body: {\r"," mode: 'urlencoded',\r"," \"urlencoded\": [\r"," { key: \"username\", value: pm.collectionVariables.get('USRENAME-SANDBOX') },\r"," { key: \"password\", value: pm.collectionVariables.get('PWD-SANDBOX') },\r"," { key: \"grant_type\", value: \"password\" }\r"," ]\r"," }\r"," }, (err, res) => {\r"," pm.collectionVariables.set(\"AccessToken\", 'Bearer ' + res.json().access_token)\r"," })"],"type":"text/javascript","packages":{}}}],"id":"547422a9-7d0b-4060-b95d-2e52d4bf59d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ApplicationToken","value":"d39bef36-e989-4a50-8301-8adaf61352a0","type":"text"},{"key":"Authorization","value":"","type":"text"},{"key":"x-request-Id","value":"1","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"CustomId\": \"\",\r\n \"amount\": 100,\r\n \"dueDate\": \"30/12/2023\",\r\n \"customer\": {\r\n \"name\": \"SANDBOX PEOPLE NAME Teste\",\r\n \"phoneNumber\": \"+12345678910121314\",\r\n \"email\": \"sandbox.people@email.sandbox.com\",\r\n \"cpfcnpj\": \"87397163769\",\r\n \"bankispb\":\"00000000\",\r\n \"bankbranch\":\"0000\",\r\n \"bankaccount\":\"0000000000\",\r\n \"address\": \"STREET 01, NUMBER 02 - HOUSE 03\",\r\n \"neighborhood\": \"NEIGHBORHOOD\",\r\n \"city\": \"CITY\",\r\n \"state\": \"UF\",\r\n \"country\": \"BRAZIL\",\r\n \"zipcode\": \"12345678\"\r\n },\r\n \"ExpirationInMinutes\": \"6\",\r\n \"confirmationUrl\": \"https://webhook.site/495472fc-207d-45ae-8c5d-731ec32779d4\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.anspacepay.com/payment/pix","description":"Create a charge for payment via PIX and return the PIX code, value, and QRCode.
\nPre-Request Script:
\n1- Before calling the \"/payment/pix\" endpoint, we must call the Token endpoint. In the Token response, we get the access_token.
\nExample:
\n{\n\"access_token\": \"akOAKwg0gb8Lt2_yziDr8y_wAOfAWziaPa9oFLZkTclIHNKKwtj8k0_K7aNMdVUooAOgBq7LpR0T23NpQwICFSnYtqbHSJrQaaP-XFiqIfQwr4buhI4DVcskwK3KZJ2bPEfdMGeNAEMay-zMm9bDdpKzs95AlI2ymPYDL8_R0V2528l4h645arRa2DV5sXwsxNvNGQRlFKsEZKF5Zp8-dQALSrsb6DUF18TsHbOGZdY\",\n\"token_type\": \"bearer\",\n\"expires_in\": 3599\n}\n\nThe access_token we will use from the request, as shown in the example below:
\nAuthorization: Bearer + access_token
\nAbout the values sent for each requirement, always consider the values divided by 100.
No comma must be sent in the requisition body, as follows:
The callback sent after the payment will return considering the same value sent, for instance, if the request was sent as 2000 to pay $20.00 the callback after payment confirmation will return the same value structure as follows:
\nApplicationToken
\nAuthorization: (bearer + token)
\nx-request-id (
\nOptional parameter where the customer can enter a hash code at the time of deposit.
\nWhen using the x-request-id parameter, the client must send in UPPERCASE.
\nThe value informed in the x-request-id parameter will be encrypted using the applicationtoken as the key.
The method used for encryption is the HMAC-SHA256 passing two parameters, the first being the value of the x-request-id, and the second the value that comes in the Applicationtoken parameter.
You can use the site https://www.devglan.com/online-tools/hmac-sha256-online to encrypt your token.
\nThis parameter will be used in callback control on successful operations.
\nThis field supports values of up to 68 characters.
\n)
\nIn response to the request, a random deposit key will be generated through the qrCodeString property.
\nThrough this code, the partner's UI will make a deposit.
\n","urlObject":{"path":["payment","pix"],"host":["https://sandbox.api.anspacepay.com"],"query":[],"variable":[]}},"response":[{"id":"f596237b-1a8b-430b-a84c-4cbb849cad2f","name":"PaymentPix","originalRequest":{"method":"POST","header":[{"key":"ApplicationToken","value":"d39bef36-e989-4a50-8301-8adaf61352a0","type":"text"},{"key":"Authorization","value":"","type":"text"},{"key":"x-request-Id","value":"1","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"CustomId\": \"\",\r\n \"amount\": 100,\r\n \"dueDate\": \"30/12/2023\",\r\n \"customer\": {\r\n \"name\": \"SANDBOX PEOPLE NAME\",\r\n \"phoneNumber\": \"+12345678910121314\",\r\n \"email\": \"sandbox.people@email.sandbox.com\",\r\n \"cpfcnpj\": \"87397163769\",\r\n \"bankispb\":\"00000000\",\r\n \"bankbranch\":\"0000\",\r\n \"bankaccount\":\"0000000000\",\r\n \"address\": \"STREET 01, NUMBER 02 - HOUSE 03\",\r\n \"neighborhood\": \"NEIGHBORHOOD\",\r\n \"city\": \"CITY\",\r\n \"state\": \"UF\",\r\n \"country\": \"BRAZIL\",\r\n \"zipcode\": \"12345678\"\r\n },\r\n \"ExpirationInMinutes\": \"6\",\r\n \"confirmationUrl\": \"https://webhook.site/495472fc-207d-45ae-8c5d-731ec32779d4\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.anspacepay.com/payment/pix"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"547422a9-7d0b-4060-b95d-2e52d4bf59d7"},{"name":"PutConfirmation","event":[{"listen":"prerequest","script":{"exec":["var Atual = new Date()\r","var customId = Number(Atual)\r","pm.collectionVariables.set('CustomId', customId)\r","\r","//Checa se as variaveis obrigatorias estao preenchidas\r","if (!pm.collectionVariables.get('USRENAME-SANDBOX') || !pm.collectionVariables.get('PWD-SANDBOX')){\r"," throw new Error('Usuario ou senha em branco')\r","}\r","if (!pm.collectionVariables.get('TOKEN-SANDBOX')){\r"," throw new Error('ApplicationToken em branco')\r","}\r","pm.sendRequest({\r"," url: pm.collectionVariables.get('SANDBOX') + '/token',\r"," method: 'POST',\r"," header: {'content-type': 'application/x-www-form-urlencoded'},\r"," body: {\r"," mode: 'urlencoded',\r"," \"urlencoded\": [\r"," { key: \"username\", value: pm.collectionVariables.get('USRENAME-SANDBOX') },\r"," { key: \"password\", value: pm.collectionVariables.get('PWD-SANDBOX') },\r"," { key: \"grant_type\", value: \"password\" }\r"," ]\r"," }\r"," }, (err, res) => {\r"," pm.collectionVariables.set(\"AccessToken\", 'Bearer ' + res.json().access_token)\r"," })"],"type":"text/javascript","id":"0e105e2e-2186-47aa-87d0-efc62eb6342c"}}],"id":"15206047-f70c-45c7-b9ea-ef221b682173","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"ApplicationToken","value":"d39bef36-e989-4a50-8301-8adaf61352a0","type":"text"},{"key":"Authorization","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"a7303ba1-c265-4400-ad69-6e64e7e560b0\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.anspacepay.com/invoice/putconfirmation","description":"Sends payment confirmation to the URL informed when creating the charge if it has already been paid.
\nFor payment confirmation validation purposes, in a Sandbox environment, this method sends a request to the URL every time it is executed, regardless of the current billing status.
\nStatus:
\nCanceled
\nPaid
\nExpired
\nPending
\nUnknown
\nEndpoint is responsible for carrying out deposit operations.
\n","_postman_id":"7af13d12-320d-451e-8d6e-ae251e693498"},{"name":"Withdraw","item":[{"name":"TransferPix","event":[{"listen":"prerequest","script":{"id":"5f55b131-f084-4c93-9ee1-c9f4fbaccd57","exec":["var Atual = new Date()\r","var customId = Number(Atual)\r","pm.collectionVariables.set('CustomId', customId)\r","\r","//Checa se as variaveis obrigatorias estao preenchidas\r","if (!pm.collectionVariables.get('USRENAME-SANDBOX') || !pm.collectionVariables.get('PWD-SANDBOX')){\r"," throw new Error('Usuario ou senha em branco')\r","}\r","if (!pm.collectionVariables.get('TOKEN-SANDBOX')){\r"," throw new Error('ApplicationToken em branco')\r","}\r","pm.sendRequest({\r"," url: pm.collectionVariables.get('SANDBOX') + '/token',\r"," method: 'POST',\r"," header: {'content-type': 'application/x-www-form-urlencoded'},\r"," body: {\r"," mode: 'urlencoded',\r"," \"urlencoded\": [\r"," { key: \"username\", value: pm.collectionVariables.get('USRENAME-SANDBOX') },\r"," { key: \"password\", value: pm.collectionVariables.get('PWD-SANDBOX') },\r"," { key: \"grant_type\", value: \"password\" }\r"," ]\r"," }\r"," }, (err, res) => {\r"," var signBytes = CryptoJS.HmacSHA256(res.json().access_token, pm.collectionVariables.get('CRP-TOKEN'));\r"," var signHex = CryptoJS.enc.Hex.stringify(signBytes);\r"," pm.collectionVariables.set('AssinaturaDigital', signHex);\r"," pm.collectionVariables.set(\"AccessToken\", 'Bearer ' + res.json().access_token)\r"," })"],"type":"text/javascript","packages":{}}}],"id":"a69ff7aa-d3e7-40de-ac16-8642b5642038","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ApplicationToken","value":"d39bef36-e989-4a50-8301-8adaf61352a0","type":"text"},{"key":"Authorization","value":"","type":"text"},{"key":"x-request-id","value":"1","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"digitalSignature\": \"\",\r\n \"amount\": 1,\r\n \"customId\": \"\",\r\n \"favorecido\": {\r\n \"nome\": \"SANDBOX PEOPLE NAME\",\r\n \"cpfcnpj\": \"87397163769\",\r\n \"chave\": {\r\n \"idTipoChavePIX\": 1,\r\n \"chavePIX\": \"87397163769\"\r\n },\r\n \"bankispb\":\"00000000\",\r\n \"bankbranch\":\"0000\",\r\n \"bankaccount\":\"0000000000\"\r\n },\r\n \"confirmationUrl\": \"https://webhook.site/d876c0f1-0c9a-48db-90e1-23fa975b1d5a\",\r\n \"updateUrl\": \"https://webhook.site/bd2f10b5-daa1-4980-87c5-50d38b182a36\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.anspacepay.com/transfer/pix","description":"Responsible for carrying out the withdrawal.
\nPre-Request Script:
\n1- Before calling the \"/transfer/pix\" endpoint, we must call the Token endpoint. In the Token response, we get the access_token.
\nExample:
\n{\n\"access_token\": \"akOAKwg0gb8Lt2_yziDr8y_wAOfAWziaPa9oFLZkTclIHNKKwtj8k0_K7aNMdVUooAOgBq7LpR0T23NpQwICFSnYtqbHSJrQaaP-XFiqIfQwr4buhI4DVcskwK3KZJ2bPEfdMGeNAEMay-zMm9bDdpKzs95AlI2ymPYDL8_R0V2528l4h645arRa2DV5sXwsxNvNGQRlFKsEZKF5Zp8-dQALSrsb6DUF18TsHbOGZdY\",\n\"token_type\": \"bearer\",\n\"expires_in\": 3599\n}\n\n2- After generating the Token, we will use the HMAC-SHA256 function passing two input parameters. Being the first access_token, and the second 8E765DB0-9C1C-44D0-85AB-8FD0B2E7D7CD (SANDBOX environment)
\nThe result of the HMAC-SHA256 operation must be stored in a variable.
\nExample Postman:
\nvar signBytes = CryptoJS.HmacSHA256(res.json().access_token, pm.collectionVariables.get('CRP-TOKEN'));
\n3- Next, we must use a function to convert the result of the HMAC-SHA256 operation into a hexadecimal string. The resulting hexadecimal string is stored in the signHex variable.
\nExample Postman:
\nvar signHex = CryptoJS.enc.Hex.stringify(signBytes);
\nThe result stored in the signHex variable will be used in the request body, in the \"digitalSignature\" property.
\nApplicationToken
\nAuthorization: (bearer + token)
\nx-request-id (
\nOptional parameter where the customer can enter a hash code at the time of withdrawal.
\nWhen using the x-request-id parameter, the client must send in UPPERCASE.
\nThe value informed in the x-request-id parameter will be encrypted using the applicationtoken as key.
The method used for encryption is the
HMAC-SHA256 passing two parameters, the first being the value of the x-resquest-id, and the second being the value of the Applicationtoken parameter.
You can use the site https://www.devglan.com/online-tools/hmac-sha256-online to encrypt your token.
\nThis parameter will be used in callback control on successful operations.
\nThis field supports values of up to 68 characters.
\n)
\nBody Request
\nidTipoChavePIX field only accepts integer values.
\nTypes accepted in these fields:
\n1 - CPF ou CNPJ (CPF - Individual Taxpayer Registration, CNPJ - National Registry of Legal Entities)
2 - Phone
3 - Email
4 - Random
Response:
\n","urlObject":{"path":["transfer","pix"],"host":["https://sandbox.api.anspacepay.com"],"query":[],"variable":[]}},"response":[{"id":"eeedbf7e-db04-4bc9-ba89-af02a832bc44","name":"TransferPix","originalRequest":{"method":"POST","header":[{"key":"ApplicationToken","value":"d39bef36-e989-4a50-8301-8adaf61352a0","type":"text"},{"key":"Authorization","value":"","type":"text"},{"key":"x-request-id","value":"1","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"digitalSignature\": \"\",\r\n \"amount\": 1,\r\n \"customId\": \"\",\r\n \"favorecido\": {\r\n \"nome\": \"SANDBOX PEOPLE NAME\",\r\n \"cpfcnpj\": \"87397163769\",\r\n \"chave\": {\r\n \"idTipoChavePIX\": 1,\r\n \"chavePIX\": \"87397163769\"\r\n },\r\n \"bankispb\":\"00000000\",\r\n \"bankbranch\":\"0000\",\r\n \"bankaccount\":\"0000000000\"\r\n },\r\n \"confirmationUrl\": \"https://webhook.site/495472fc-207d-45ae-8c5d-731ec32779d4\",\r\n \"updateUrl\": \"https://webhook.site/495472fc-207d-45ae-8c5d-731ec32779d4\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.anspacepay.com/transfer/pix"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"273","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true},{"key":"Expires","value":"Thu, 20 Jul 2023 15:51:47 GMT","enabled":true},{"key":"Cache-Control","value":"max-age=0, no-cache, no-store","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Date","value":"Thu, 20 Jul 2023 15:51:47 GMT","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"error\": false,\n \"returnCode\": \"00\",\n \"returnMessage\": \"Success\",\n \"withdrawCode\": \"1JQM8ATLAL\",\n \"customId\": \"1689868304861\",\n \"authenticationCode\": \"28772fc4-3cc7-4aae-85d2-5af515ec0a0a\",\n \"transactionId\": \"28772fc4-3cc7-4aae-85d2-5af515ec0a0a\",\n \"status\": \"Received and Awaiting processing\"\n}"}],"_postman_id":"a69ff7aa-d3e7-40de-ac16-8642b5642038"},{"name":"PixPutConfirmation","event":[{"listen":"prerequest","script":{"exec":["var Atual = new Date()\r","var customId = Number(Atual)\r","pm.collectionVariables.set('CustomId', customId)\r","\r","//Checa se as variaveis obrigatorias estao preenchidas\r","if (!pm.collectionVariables.get('USRENAME-SANDBOX') || !pm.collectionVariables.get('PWD-SANDBOX')){\r"," throw new Error('Usuario ou senha em branco')\r","}\r","if (!pm.collectionVariables.get('TOKEN-SANDBOX')){\r"," throw new Error('ApplicationToken em branco')\r","}\r","pm.sendRequest({\r"," url: pm.collectionVariables.get('SANDBOX') + '/token',\r"," method: 'POST',\r"," header: {'content-type': 'application/x-www-form-urlencoded'},\r"," body: {\r"," mode: 'urlencoded',\r"," \"urlencoded\": [\r"," { key: \"username\", value: pm.collectionVariables.get('USRENAME-SANDBOX') },\r"," { key: \"password\", value: pm.collectionVariables.get('PWD-SANDBOX') },\r"," { key: \"grant_type\", value: \"password\" }\r"," ]\r"," }\r"," }, (err, res) => {\r"," var signBytes = CryptoJS.HmacSHA256(res.json().access_token, pm.collectionVariables.get('CRP-TOKEN'));\r"," var signHex = CryptoJS.enc.Hex.stringify(signBytes);\r"," pm.collectionVariables.set('AssinaturaDigital', signHex);\r"," console.log(signHex);\r"," pm.collectionVariables.set(\"AccessToken\", 'Bearer ' + res.json().access_token)\r"," })"],"type":"text/javascript","id":"babe7498-1465-417b-b17d-c4e516e2418f"}}],"id":"31f8a33d-e82a-4bad-a25e-d9ef97bc2b5e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"ApplicationToken","value":"d39bef36-e989-4a50-8301-8adaf61352a0","type":"text"},{"key":"Authorization","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"digitalSignature\": \"\",\r\n \"withdrawCode\": \"DLPKY7JGCJ\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.anspacepay.com/transfer/putconfirmation","description":"Putconfirmation Status:
\nCompleted = Withdrawal Paid
Chargeback = Withdrawal reversed
Paid and Wait = Received and in process (awaiting bank confirmation)
unknown = unknown
Endpoints responsible for the withdrawal operation.
\n","_postman_id":"a3d4ebe1-eecf-44b7-86e1-62f867146f7f"},{"name":"Webhook","item":[],"id":"997a915a-f88e-468e-b8ac-744679ceda7b","description":"Once the deposit is requested using the deposit method \"/payment/pix,\" the QRCode Pix will be generated for the deposit to be made, and it will remain in pending status until it is paid. After payment, the system will return the data according to the JSON below:
\nDeposit completed: this is a finished event (\"status\": \"Paid\").
\n{\n\"id\": \"cac5642a-9679-41cc-bf1d-014d33b9f8b2\",\n\"txId\": \"806aa601d8984f73910fba2a066660e4\",\n\"total\": 100000,\n\"status\": \"Paid\",\n\"customId\": \"PBC1003311818687659648880640\",\n\"endToEnd\": \"E9040088820240731164425105552676\",\n\"totalPaid\": 100000,\n\"invoiceCode\": \"PPNLZOE\",\n\"ispbPagador\": \"90400888\",\n\"nomePagador\": \"55 640 295 MARCELO ALEXANDRE SILVA JUNIO\",\n\"paymentDate\": \"2024-07-31T13:44:43.347\",\n\"emailPagador\": null,\n\"installments\": 1,\n\"paymentmethod\": \"PIX\",\n\"cpfCnpjPagador\": \"55640295000152\",\n\"telefonePagador\": null,\n\"nomeBancoPagador\": \"BCO SANTANDER (BRASIL) S.A.\",\n\"payment_currency\": \"BRL\",\n\"original_currency\": \"BRL\",\n\"paid_by_cripto_currency\": \"false\"\n}\n\nWithdraw sent to the bank and awaiting confirmation: This status will rarely occur, since it goes directly to \"paid\" because transactions via PIX used to occur instantly.
\n{\n\"error\":false,\n\"returnCode\":\"00\",\n\"returnMessage\":\"Success\",\n\"withdrawCode\":\"F5RNZ9YT3I\",\n\"customId\": \"1689806298819\",\n\"authenticationCode\":\"a63c0bd8-cd86-4240-8039-927d2b1ccd58\",\n\"transactionCode\":\"E710278662023011402595500001213P\",\n\"transaction\":{\n\"operationType\":\"PIX\",\n\"transactionDate\":\"2023-01-13T23:59:54.667\",\n\"completedDate\":null,\n\"chargebackDate\":null,\n\"paymentDate\":\"2023-01-13T23:59:59.45\"\n},\n\"recipient\":{\n\"recipientName\":\"VANDERLENIR LOIOLA LIMA\",\n\"recipientDocumentID\":\"01845023226\",\n\"recipientBankAgency\":null,\n\"recipientBankAccount\":\"-\",\n\"recipientPIXKeyType\":\"Celular\",\n\"recipientPIXKey\":\"+5596991526191\"\n},\n\"requestDate\":\"2023-01-13T23:59:54.667\",\n\"paymentDate\":\"2023-01-13T23:59:59.45\",\n\"chargebackDate\":null,\n\"completionDate\":null,\n\"status\":\"Paid and Waiting Confirmation\"\n}\n\nAdministrative returned transaction: The transaction has been denied due to a sending error and another transaction (preferably using a new CustomID) must be sent.
\n{\n \"withdrawCode\": \"RPANT6LE28\",\n \"customId\": \"1723833777785\",\n \"transactionId\": \"1534a097-9987-4162-bbe1-defa7b45969d\",\n \"transactionCode\": null,\n \"updateCode\": \"02\",\n \"updateMessage\": \"RETURNED TRANSACTION\",\n \"amount\": 100,\n \"reason\": \"Estorno admin\"\n}\n\nFor any updates into transactions, we use updateUrl.
if one transaction is received, started payment (bank of Brazil), and completed, we use the confirmationUrl that you sent when the request is made
If one transaction is received, the payment is started at the bank and during this process a problem occurs, our system will send the callback to you using the updateUrl, Update the status instead of \"Received and Processing\" to \"Rejected\" or \"Declined\"
Because of this, the response model is not the same.
Please attention to the case:
In a production environment, one transaction can be 100% completed and after the same minutes the central bank of Brazil updates the status to Rejected, and in this case, we send the callback to you 2 times.
First time through confirmationUrl to inform that transaction was completed, and then, through updateUrl to inform that a problem occurred.
Examples:
\nBelow are the examples of requests to updateUrl:
\nIn this case, instability occurred in the payment system of the Brazilian Central Bank or in the banks that we use:
\n{\n\"withdrawCode\": \"3BKT9405J6\",\n\"customId\": \"1689806298819\",\n\"transactionCode\": null,\n\"updateCode\": \"01\",\n\"updateMessage\": \"INSTABILITY\"\n}\n\nIn this case, instability occurred in the payment system of the Brazilian Central Bank or in the banks that we use or in the target bank (bank of the user):
\n{\n\"withdrawCode\": \"3BKT9405J6\",\n\"customId\": \"1689806298819\",\n\"transactionCode\": null,\n\"updateCode\": \"02\",\n\"updateMessage\": \"RETURNED TRANSACTION\"\n}\n\nIn this case, the target bank (bank of the user) rejects the transaction for any causes:
\n{\n\"withdrawCode\": \"3BKT9405J6\",\n\"customId\": \"1689806298819\",\n\"transactionCode\": null,\n\"updateCode\": \"03\",\n\"updateMessage\": \"REJECTED TRANSACTION\"\n}\n\nIn these 3 cases, the transaction was DECLINED and the balance must be reset to the user.
\nExemple:
\nWithdraw completed:
\n{\n\"error\": false,\n\"returnCode\": \"00\",\n\"returnMessage\": \"Success\",\n\"withdrawCode\": \"F5RNZ9YT3I\",\n\"customId\": \"1689806298819\",\n\"authenticationCode\": \"a63c0bd8-cd86-4240-8039-927d2b1ccd58\",\n\"transactionCode\": \"E710278662023011402595500001213P\",\n\"transaction\":{\n\"operationType\": \"PIX\",\n\"transactionDate\":\"2023-01-13T23:59:54.667\",\n\"completedDate\":\"2023-01-13T23:59:59.45\",\n\"chargebackDate\":null,\n\"paymentDate\":\"2023-01-13T23:59:59.45\"\n},\n\"recipient\":{\n\"recipientName\":\"VANDERLENIR LOIOLA LIMA\",\n\"recipientDocumentID\":\"01845023226\",\n\"recipientBankAgency\":null,\n\"recipientBankAccount\":\"-\",\n\"recipientPIXKeyType\":\"Celular\",\n\"recipientPIXKey\":\"+5596991526191\"\n},\n\"requestDate\":\"2023-01-13T23:59:54.667\",\n\"paymentDate\":\"2023-01-13T23:59:59.45\",\n\"chargebackDate\":null,\n\"completionDate\":\"2023-01-13T23:59:59.45\",\n\"status\":\"Completed\"\n}\n\nWithdraw received and waiting to be processed for the bank:
\n{\n\"error\":false,\n\"returnCode\":\"00\",\n\"returnMessage\":\"Success\",\n\"withdrawCode\":\"F5RNZ9YT3I\",\n\"customId\": \"1689806298819\",\n\"authenticationCode\":\"a63c0bd8-cd86-4240-8039-927d2b1ccd58\",\n\"transactionCode\":\"E710278662023011402595500001213P\",\n\"transaction\":{\n\"operationType\":\"PIX\",\n\"transactionDate\":\"2023-01-13T23:59:54.667\",\n\"completedDate\":null,\n\"chargebackDate\":null,\n\"paymentDate\":null\n},\n\"recipient\":{\n\"recipientName\":\"VANDERLENIR LOIOLA LIMA\",\n\"recipientDocumentID\":\"01845023226\",\n\"recipientBankAgency\":null,\n\"recipientBankAccount\":\"-\",\n\"recipientPIXKeyType\":\"Celular\",\n\"recipientPIXKey\":\"+5596991526191\"\n}\n,\n\"requestDate\":\"2023-01-13T23:59:54.667\",\n\"paymentDate\":null,\n\"chargebackDate\":null,\n\"completionDate\":null,\n\"status\":\"Received and Awaiting processing\"\n}\n\nPlease note that there are 2 URLs, one for confirmation (confirmationUrl) and another for update (updateUrl). We recommend that these be different, as this would help with identification.
\nCurrently, the return and confirmation data structures are different. If there is a field in our webhook called returnCode (this will always be 00), it means that the withdrawal transaction was successful.
\nIf there is a field called updateCode (which can be 01, 02, 03), any of these means that the withdrawal was reversed.
\nNote: Even after confirmation (a rare case), the customer may receive a reversal webhook, so a rollback (reversal) is also necessary on your side.
\nThe x-request-id parameter was implemented in the callback.
\nThis parameter will be used in callback control on successful operations.
\nThe x-request-id parameter will be sent in the header of the callback function.
\n","_postman_id":"997a915a-f88e-468e-b8ac-744679ceda7b"}],"id":"97a909e3-d908-4013-b5e8-1140f0faba8c","_postman_id":"97a909e3-d908-4013-b5e8-1140f0faba8c","description":""},{"name":"Error table","item":[],"id":"92157752-6849-4b4c-a98c-13dacf76868d","description":"","_postman_id":"92157752-6849-4b4c-a98c-13dacf76868d"},{"name":"Health","item":[{"name":"HealthCheck","id":"aca1d30c-0ac9-4fbd-a0e2-ccb3e888dcdf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.anspacepay.com/health/check","urlObject":{"path":["health","check"],"host":["https://sandbox.api.anspacepay.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"aca1d30c-0ac9-4fbd-a0e2-ccb3e888dcdf"},{"name":"HealhPost","id":"b1d4f3f0-56a9-4d73-b597-475d8752f233","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ApplicationToken","value":"d39bef36-e989-4a50-8301-8adaf61352a0","type":"text"},{"key":"Authorization","value":"","type":"text"}],"url":"https://sandbox.api.anspacepay.com/Health/Post?url=http%3A%2F%2Fsandbox.api.anspacepay.com","urlObject":{"path":["Health","Post"],"host":["https://sandbox.api.anspacepay.com"],"query":[{"key":"url","value":"http%3A%2F%2Fsandbox.api.anspacepay.com"}],"variable":[]}},"response":[],"_postman_id":"b1d4f3f0-56a9-4d73-b597-475d8752f233"}],"id":"77123b60-e3aa-4b5b-97e1-91c0f185b26e","description":"Provides routes for API health validation
\n","_postman_id":"77123b60-e3aa-4b5b-97e1-91c0f185b26e"},{"name":"BankSlip","item":[{"name":"UpdateDueDate","event":[{"listen":"prerequest","script":{"exec":["var Atual = new Date()\r","var customId = Number(Atual)\r","pm.collectionVariables.set('CustomId', customId)\r","\r","//Checa se as variaveis obrigatorias estao preenchidas\r","if (!pm.collectionVariables.get('USRENAME-SANDBOX') || !pm.collectionVariables.get('PWD-SANDBOX')){\r"," throw new Error('Usuario ou senha em branco')\r","}\r","if (!pm.collectionVariables.get('TOKEN-SANDBOX')){\r"," throw new Error('ApplicationToken em branco')\r","}\r","pm.sendRequest({\r"," url: pm.collectionVariables.get('SANDBOX') + '/token',\r"," method: 'POST',\r"," header: {'content-type': 'application/x-www-form-urlencoded'},\r"," body: {\r"," mode: 'urlencoded',\r"," \"urlencoded\": [\r"," { key: \"username\", value: pm.collectionVariables.get('USRENAME-SANDBOX') },\r"," { key: \"password\", value: pm.collectionVariables.get('PWD-SANDBOX') },\r"," { key: \"grant_type\", value: \"password\" }\r"," ]\r"," }\r"," }, (err, res) => {\r"," pm.collectionVariables.set(\"AccessToken\", 'Bearer ' + res.json().access_token)\r"," })"],"type":"text/javascript","id":"377d9bc2-ddd8-4194-85f7-5c3723324732"}}],"id":"cad77d87-81a3-4315-96e0-55484837f431","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"ApplicationToken","value":"d39bef36-e989-4a50-8301-8adaf61352a0","type":"text"},{"key":"Authorization","value":"","type":"text"},{"key":"x-request-id","value":"1","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"bankSlipOurNumber\": \"1\",\r\n \"bankSlipYourNumber\": \"2\",\r\n \"dueDate\": \"22/05/2023\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.anspacepay.com/BankSlip/UpdateDueDate","description":"Update payment slip due date (BS2)
\n","urlObject":{"path":["BankSlip","UpdateDueDate"],"host":["https://sandbox.api.anspacepay.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"cad77d87-81a3-4315-96e0-55484837f431"}],"id":"405a597b-f3eb-4980-bc6b-8c1654e9d23b","_postman_id":"405a597b-f3eb-4980-bc6b-8c1654e9d23b","description":""},{"name":"Bitcoin","item":[{"name":"Send","event":[{"listen":"prerequest","script":{"exec":["var Atual = new Date()\r","var customId = Number(Atual)\r","pm.collectionVariables.set('CustomId', customId)\r","\r","//Checa se as variaveis obrigatorias estao preenchidas\r","if (!pm.collectionVariables.get('USRENAME-SANDBOX') || !pm.collectionVariables.get('PWD-SANDBOX')){\r"," throw new Error('Usuario ou senha em branco')\r","}\r","if (!pm.collectionVariables.get('TOKEN-SANDBOX')){\r"," throw new Error('ApplicationToken em branco')\r","}\r","pm.sendRequest({\r"," url: pm.collectionVariables.get('SANDBOX') + '/token',\r"," method: 'POST',\r"," header: {'content-type': 'application/x-www-form-urlencoded'},\r"," body: {\r"," mode: 'urlencoded',\r"," \"urlencoded\": [\r"," { key: \"username\", value: pm.collectionVariables.get('USRENAME-SANDBOX') },\r"," { key: \"password\", value: pm.collectionVariables.get('PWD-SANDBOX') },\r"," { key: \"grant_type\", value: \"password\" }\r"," ]\r"," }\r"," }, (err, res) => {\r"," pm.collectionVariables.set(\"AccessToken\", 'Bearer ' + res.json().access_token)\r"," })"],"type":"text/javascript","id":"924ab080-b788-4317-8644-95599f2c8d76"}}],"id":"d69a375b-9d55-48aa-9bae-4ff6fb61f5d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ApplicationToken","value":"d39bef36-e989-4a50-8301-8adaf61352a0","type":"text"}],"url":"https://sandbox.api.anspacepay.com/Bitcoin/Send","urlObject":{"path":["Bitcoin","Send"],"host":["https://sandbox.api.anspacepay.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d69a375b-9d55-48aa-9bae-4ff6fb61f5d7"},{"name":"ValidateAddress","event":[{"listen":"prerequest","script":{"exec":["var Atual = new Date()\r","var customId = Number(Atual)\r","pm.collectionVariables.set('CustomId', customId)\r","\r","//Checa se as variaveis obrigatorias estao preenchidas\r","if (!pm.collectionVariables.get('USRENAME-SANDBOX') || !pm.collectionVariables.get('PWD-SANDBOX')){\r"," throw new Error('Usuario ou senha em branco')\r","}\r","if (!pm.collectionVariables.get('TOKEN-SANDBOX')){\r"," throw new Error('ApplicationToken em branco')\r","}\r","pm.sendRequest({\r"," url: pm.collectionVariables.get('SANDBOX') + '/token',\r"," method: 'POST',\r"," header: {'content-type': 'application/x-www-form-urlencoded'},\r"," body: {\r"," mode: 'urlencoded',\r"," \"urlencoded\": [\r"," { key: \"username\", value: pm.collectionVariables.get('USRENAME-SANDBOX') },\r"," { key: \"password\", value: pm.collectionVariables.get('PWD-SANDBOX') },\r"," { key: \"grant_type\", value: \"password\" }\r"," ]\r"," }\r"," }, (err, res) => {\r"," pm.collectionVariables.set(\"AccessToken\", 'Bearer ' + res.json().access_token)\r"," })"],"type":"text/javascript","id":"85f9a5b8-f739-469b-b896-d7687f32d372"}}],"id":"76d87138-d51e-4a66-9d2c-e72e9613385f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"ApplicationToken","value":"d39bef36-e989-4a50-8301-8adaf61352a0","type":"text"}],"url":"https://sandbox.api.anspacepay.com/Bitcoin/ValidateAddress?address=your-adress","urlObject":{"path":["Bitcoin","ValidateAddress"],"host":["https://sandbox.api.anspacepay.com"],"query":[{"key":"address","value":"your-adress"}],"variable":[]}},"response":[],"_postman_id":"76d87138-d51e-4a66-9d2c-e72e9613385f"}],"id":"541f9c3a-c9a9-4dd8-b0cc-f4fc345e8abd","_postman_id":"541f9c3a-c9a9-4dd8-b0cc-f4fc345e8abd","description":""},{"name":"Customer","item":[{"name":"CreateCustomer","event":[{"listen":"prerequest","script":{"exec":["var Atual = new Date()\r","var customId = Number(Atual)\r","pm.collectionVariables.set('CustomId', customId)\r","\r","//Checa se as variaveis obrigatorias estao preenchidas\r","if (!pm.collectionVariables.get('USRENAME-SANDBOX') || !pm.collectionVariables.get('PWD-SANDBOX')){\r"," throw new Error('Usuario ou senha em branco')\r","}\r","if (!pm.collectionVariables.get('TOKEN-SANDBOX')){\r"," throw new Error('ApplicationToken em branco')\r","}\r","pm.sendRequest({\r"," url: pm.collectionVariables.get('SANDBOX') + '/token',\r"," method: 'POST',\r"," header: {'content-type': 'application/x-www-form-urlencoded'},\r"," body: {\r"," mode: 'urlencoded',\r"," \"urlencoded\": [\r"," { key: \"username\", value: pm.collectionVariables.get('USRENAME-SANDBOX') },\r"," { key: \"password\", value: pm.collectionVariables.get('PWD-SANDBOX') },\r"," { key: \"grant_type\", value: \"password\" }\r"," ]\r"," }\r"," }, (err, res) => {\r"," pm.collectionVariables.set(\"AccessToken\", 'Bearer ' + res.json().access_token)\r"," })"],"type":"text/javascript","id":"0ed74f14-5602-479e-8c55-3aaaafa83d4e"}}],"id":"e344f5a4-b6ac-4236-94f0-c3583fd3df64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ApplicationToken","value":"d39bef36-e989-4a50-8301-8adaf61352a0","type":"text"}],"url":"https://sandbox.api.anspacepay.com/Customer/CreateCustomer","urlObject":{"path":["Customer","CreateCustomer"],"host":["https://sandbox.api.anspacepay.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e344f5a4-b6ac-4236-94f0-c3583fd3df64"}],"id":"fe8e1c14-0d86-4ff1-9d3c-67820566f2a9","_postman_id":"fe8e1c14-0d86-4ff1-9d3c-67820566f2a9","description":""},{"name":"Financial","item":[{"name":"PostRebalancingAccounts","event":[{"listen":"prerequest","script":{"exec":["var Atual = new Date()\r","var customId = Number(Atual)\r","pm.collectionVariables.set('CustomId', customId)\r","\r","//Checa se as variaveis obrigatorias estao preenchidas\r","if (!pm.collectionVariables.get('USRENAME-SANDBOX') || !pm.collectionVariables.get('PWD-SANDBOX')){\r"," throw new Error('Usuario ou senha em branco')\r","}\r","if (!pm.collectionVariables.get('TOKEN-SANDBOX')){\r"," throw new Error('ApplicationToken em branco')\r","}\r","pm.sendRequest({\r"," url: pm.collectionVariables.get('SANDBOX') + '/token',\r"," method: 'POST',\r"," header: {'content-type': 'application/x-www-form-urlencoded'},\r"," body: {\r"," mode: 'urlencoded',\r"," \"urlencoded\": [\r"," { key: \"username\", value: pm.collectionVariables.get('USRENAME-SANDBOX') },\r"," { key: \"password\", value: pm.collectionVariables.get('PWD-SANDBOX') },\r"," { key: \"grant_type\", value: \"password\" }\r"," ]\r"," }\r"," }, (err, res) => {\r"," var signBytes = CryptoJS.HmacSHA256(res.json().access_token, pm.collectionVariables.get('CRP-TOKEN'));\r"," var signHex = CryptoJS.enc.Hex.stringify(signBytes);\r"," pm.collectionVariables.set('AssinaturaDigital', signHex);\r"," pm.collectionVariables.set(\"AccessToken\", 'Bearer ' + res.json().access_token)\r"," })"],"type":"text/javascript","packages":{},"id":"65f7bde3-5c16-4b61-ac8a-93e7d9cba0a4"}}],"id":"d2177e9f-4717-4977-ab78-a6ec071c505b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ApplicationToken","value":"d39bef36-e989-4a50-8301-8adaf61352a0","type":"text"},{"key":"digitalSignature","value":"","type":"text"},{"key":"Authorization","value":"","type":"text"}],"url":"https://sandbox.api.anspacepay.com/Financial/PostRebalancingAccounts","description":"The endpoint postRebalancingAccounts (double: amountGraphicAccounts) sends the balance of the graphic accounts and we sync the transactional account (debiting/crediting the proprietary account).
\nFor the client to request this EndPoint, just follow the following rules:
1 - authenticate in the API the same way you authenticate to call any other method
2 - send the parameter in the Header: ApplicationToken
3 - send in the body of the request in the \"application/json\" format
4 - the body contains only 1 parameter called: \"digitalSignature\" it must contain the same digital signature sent in the Tranfer/Pix method, respecting the encryption rules described in our documents.
Response:
\n{\n \"error\": false,\n \"returnMessage\": \"Sucess\"\n}\n\nApplicationToken - Required
\ndigitalSignature - Required
\nAuthorization - Required
\nBody = None
\n","urlObject":{"path":["Financial","PostRebalancingAccounts"],"host":["https://sandbox.api.anspacepay.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d2177e9f-4717-4977-ab78-a6ec071c505b"},{"name":"GetRealBalanceSummary","event":[{"listen":"prerequest","script":{"id":"152a660d-27af-4e22-8a57-ac93e6a3f3ff","exec":["var Atual = new Date()\r","var customId = Number(Atual)\r","pm.collectionVariables.set('CustomId', customId)\r","\r","//Checa se as variaveis obrigatorias estao preenchidas\r","if (!pm.collectionVariables.get('USRENAME-SANDBOX') || !pm.collectionVariables.get('PWD-SANDBOX')){\r"," throw new Error('Usuario ou senha em branco')\r","}\r","if (!pm.collectionVariables.get('TOKEN-SANDBOX')){\r"," throw new Error('ApplicationToken em branco')\r","}\r","pm.sendRequest({\r"," url: pm.collectionVariables.get('SANDBOX') + '/token',\r"," method: 'POST',\r"," header: {'content-type': 'application/x-www-form-urlencoded'},\r"," body: {\r"," mode: 'urlencoded',\r"," \"urlencoded\": [\r"," { key: \"username\", value: pm.collectionVariables.get('USRENAME-SANDBOX') },\r"," { key: \"password\", value: pm.collectionVariables.get('PWD-SANDBOX') },\r"," { key: \"grant_type\", value: \"password\" }\r"," ]\r"," }\r"," }, (err, res) => {\r"," var signBytes = CryptoJS.HmacSHA256(res.json().access_token, pm.collectionVariables.get('CRP-TOKEN'));\r"," var signHex = CryptoJS.enc.Hex.stringify(signBytes);\r"," pm.collectionVariables.set('AssinaturaDigital', signHex);\r"," pm.collectionVariables.set(\"AccessToken\", 'Bearer ' + res.json().access_token)\r"," })"],"type":"text/javascript","packages":{}}}],"id":"768b24f2-06bf-4098-828e-cb8cb747b71e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"ApplicationToken","value":"d39bef36-e989-4a50-8301-8adaf61352a0","type":"text"},{"key":"digitalSignature","value":"","type":"text"},{"key":"Authorization","value":"","type":"text"}],"url":"https://sandbox.api.anspacepay.com/Financial/GetRealBalanceSummary","description":"This endpoint [ApplicationToken, Authorization, digitalSignature] (general summary) returns the current balance of the transactional and proprietary account.
\nFor the client to request this EndPoint, just follow the following rules:
1 - authenticate in the API the same way you authenticate to call any other method
2 - send the parameter in the Header: ApplicationToken
3 - send in the body of the request in the \"application/json\" format
4 - the body contains only 1 parameter called: \"digitalSignature\" it must contain the same digital signature sent in the Tranfer/Pix method, respecting the encryption rules described in our documents.
Response:
\n[\n {\n \"balanceAvailable\": 20000,\n \"balanceToReceive\": 0,\n \"currencyCode\": \"BRL\",\n \"currency\": \"Real\",\n \"symbol\": \"R$\",\n \"typeAccount\": \"Transacional\",\n \"error\": false,\n \"returnCode\": \"00\",\n \"returnMessage\": \"Success\"\n },\n {\n \"balanceAvailable\": 20000,\n \"balanceToReceive\": 0,\n \"currencyCode\": \"BRL\",\n \"currency\": \"Real\",\n \"symbol\": \"R$\",\n \"typeAccount\": \"Proprietaria\",\n \"error\": false,\n \"returnCode\": \"00\",\n \"returnMessage\": \"Success\"\n }\n]\n\nApplicationToken - Required
\ndigitalSignature - Required
\nAuthorization - Required
\nBody = None
\n","urlObject":{"path":["Financial","GetRealBalanceSummary"],"host":["https://sandbox.api.anspacepay.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"768b24f2-06bf-4098-828e-cb8cb747b71e"},{"name":"GetRealBalanceByDate","event":[{"listen":"prerequest","script":{"exec":["var Atual = new Date()\r","var customId = Number(Atual)\r","pm.collectionVariables.set('CustomId', customId)\r","\r","//Checa se as variaveis obrigatorias estao preenchidas\r","if (!pm.collectionVariables.get('USRENAME-SANDBOX') || !pm.collectionVariables.get('PWD-SANDBOX')){\r"," throw new Error('Usuario ou senha em branco')\r","}\r","if (!pm.collectionVariables.get('TOKEN-SANDBOX')){\r"," throw new Error('ApplicationToken em branco')\r","}\r","pm.sendRequest({\r"," url: pm.collectionVariables.get('SANDBOX') + '/token',\r"," method: 'POST',\r"," header: {'content-type': 'application/x-www-form-urlencoded'},\r"," body: {\r"," mode: 'urlencoded',\r"," \"urlencoded\": [\r"," { key: \"username\", value: pm.collectionVariables.get('USRENAME-SANDBOX') },\r"," { key: \"password\", value: pm.collectionVariables.get('PWD-SANDBOX') },\r"," { key: \"grant_type\", value: \"password\" }\r"," ]\r"," }\r"," }, (err, res) => {\r"," var signBytes = CryptoJS.HmacSHA256(res.json().access_token, pm.collectionVariables.get('CRP-TOKEN'));\r"," var signHex = CryptoJS.enc.Hex.stringify(signBytes);\r"," pm.collectionVariables.set('AssinaturaDigital', signHex);\r"," pm.collectionVariables.set(\"AccessToken\", 'Bearer ' + res.json().access_token)\r"," })"],"type":"text/javascript","packages":{},"id":"e0b01b9b-aff8-4694-8f7a-b43396bebc41"}}],"id":"1550dd16-4d68-4ae0-847a-b49df6b5455f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"ApplicationToken","value":"d39bef36-e989-4a50-8301-8adaf61352a0","type":"text"},{"key":"digitalSignature","value":"","type":"text"},{"key":"Authorization","value":"","type":"text"}],"url":"https://sandbox.api.anspacepay.com/Financial/GetRealBalanceByDate?Date=2024-11-08","description":"This endpoint [ApplicationToken, Authorization, digitalSignature] (date: YYYY-MM-DD BRT) passes a movement date (YYYY-MM-DD BRT) and we return the initial and final balance of the transactional and proprietary account.
\nFor the client to request this EndPoint, just follow the following rules:
1 - authenticate in the API the same way you authenticate to call any other method
2 - send the parameter in the Header: ApplicationToken
3 - send in the body of the request in the \"application/JSON\" format
4 - the body contains only 1 parameter called \"digitalSignature.\" It must contain the same digital signature sent in the Tranfer/Pix method, respecting the encryption rules described in our documents.
Response:
\n[\n {\n \"balanceAvailable\": 20000,\n \"balanceToReceive\": 0,\n \"currencyCode\": \"BRL\",\n \"currency\": \"Real\",\n \"symbol\": \"R$\",\n \"typeAccount\": \"Transacional\",\n \"error\": false,\n \"returnCode\": \"00\",\n \"returnMessage\": \"Success\"\n },\n {\n \"balanceAvailable\": 20000,\n \"balanceToReceive\": 0,\n \"currencyCode\": \"BRL\",\n \"currency\": \"Real\",\n \"symbol\": \"R$\",\n \"typeAccount\": \"Proprietaria\",\n \"error\": false,\n \"returnCode\": \"00\",\n \"returnMessage\": \"Success\"\n }\n]\n\nApplicationToken - Required
\ndigitalSignature - Required
\nAuthorization - Required
\nBody = None
\n","urlObject":{"path":["Financial","GetRealBalanceByDate"],"host":["https://sandbox.api.anspacepay.com"],"query":[{"key":"Date","value":"2024-11-08"}],"variable":[]}},"response":[],"_postman_id":"1550dd16-4d68-4ae0-847a-b49df6b5455f"},{"name":"GetRealBalance","event":[{"listen":"prerequest","script":{"exec":["var Atual = new Date()\r","var customId = Number(Atual)\r","pm.collectionVariables.set('CustomId', customId)\r","\r","//Checa se as variaveis obrigatorias estao preenchidas\r","if (!pm.collectionVariables.get('USRENAME-SANDBOX') || !pm.collectionVariables.get('PWD-SANDBOX')){\r"," throw new Error('Usuario ou senha em branco')\r","}\r","if (!pm.collectionVariables.get('TOKEN-SANDBOX')){\r"," throw new Error('ApplicationToken em branco')\r","}\r","pm.sendRequest({\r"," url: pm.collectionVariables.get('SANDBOX') + '/token',\r"," method: 'POST',\r"," header: {'content-type': 'application/x-www-form-urlencoded'},\r"," body: {\r"," mode: 'urlencoded',\r"," \"urlencoded\": [\r"," { key: \"username\", value: pm.collectionVariables.get('USRENAME-SANDBOX') },\r"," { key: \"password\", value: pm.collectionVariables.get('PWD-SANDBOX') },\r"," { key: \"grant_type\", value: \"password\" }\r"," ]\r"," }\r"," }, (err, res) => {\r"," var signBytes = CryptoJS.HmacSHA256(res.json().access_token, pm.collectionVariables.get('CRP-TOKEN'));\r"," var signHex = CryptoJS.enc.Hex.stringify(signBytes);\r"," pm.collectionVariables.set('AssinaturaDigital', signHex);\r"," pm.collectionVariables.set(\"AccessToken\", 'Bearer ' + res.json().access_token)\r"," })"],"type":"text/javascript","id":"edc4e7e9-f2a2-4b1e-b977-37359ab896f1"}}],"id":"d15d9a09-eede-498c-8974-8ee80b8d6ef4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"ApplicationToken","value":"d39bef36-e989-4a50-8301-8adaf61352a0","type":"text"},{"key":"digitalSignature","value":"","type":"text"},{"key":"Authorization","value":"","type":"text"}],"url":"https://sandbox.api.anspacepay.com/Financial/GetRealBalance","description":"This endpoint returns the current transactional balance:
\nFor the client to request this EndPoint, just follow the following rules:
1 - authenticate in the API the same way you authenticate to call any other method
2 - send the parameter in the Header: ApplicationToken
3 - send in the body of the request in the \"application/json\" format
4 - the body contains only 1 parameter called: \"digitalSignature\" it must contain the same digital signature sent in the Tranfer/Pix method, respecting the encryption rules described in our documents.
Response:
\n{\n \"balanceAvailable\": 90457465,\n \"balanceToReceive\": 0,\n \"currencyCode\": \"BRL\",\n \"currency\": \"Real\",\n \"symbol\": \"R$\",\n \"error\": false,\n \"returnCode\": \"00\",\n \"returnMessage\": \"Success\"\n}\n\nApplicationToken - Required
\ndigitalSignature - Required
\nAuthorization - Required
\nBody = None
\n","urlObject":{"path":["Financial","GetRealBalance"],"host":["https://sandbox.api.anspacepay.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d15d9a09-eede-498c-8974-8ee80b8d6ef4"},{"name":"GetBitcoinBalance","event":[{"listen":"prerequest","script":{"exec":["var Atual = new Date()\r","var customId = Number(Atual)\r","pm.collectionVariables.set('CustomId', customId)\r","\r","//Checa se as variaveis obrigatorias estao preenchidas\r","if (!pm.collectionVariables.get('USRENAME-SANDBOX') || !pm.collectionVariables.get('PWD-SANDBOX')){\r"," throw new Error('Usuario ou senha em branco')\r","}\r","if (!pm.collectionVariables.get('TOKEN-SANDBOX')){\r"," throw new Error('ApplicationToken em branco')\r","}\r","pm.sendRequest({\r"," url: pm.collectionVariables.get('SANDBOX') + '/token',\r"," method: 'POST',\r"," header: {'content-type': 'application/x-www-form-urlencoded'},\r"," body: {\r"," mode: 'urlencoded',\r"," \"urlencoded\": [\r"," { key: \"username\", value: pm.collectionVariables.get('USRENAME-SANDBOX') },\r"," { key: \"password\", value: pm.collectionVariables.get('PWD-SANDBOX') },\r"," { key: \"grant_type\", value: \"password\" }\r"," ]\r"," }\r"," }, (err, res) => {\r"," var signBytes = CryptoJS.HmacSHA256(res.json().access_token, pm.collectionVariables.get('CRP-TOKEN'));\r"," var signHex = CryptoJS.enc.Hex.stringify(signBytes);\r"," pm.collectionVariables.set('AssinaturaDigital', signHex);\r"," pm.collectionVariables.set(\"AccessToken\", 'Bearer ' + res.json().access_token)\r"," })"],"type":"text/javascript","id":"d01b8e49-4d28-477a-a1e1-7453073f9650"}}],"id":"917d6db3-4fe7-490b-b62e-e65ad3daa52c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"ApplicationToken","value":"d39bef36-e989-4a50-8301-8adaf61352a0","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"digitalSignature\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.anspacepay.com/Financial/GetBitcoinBalance?ApplicationToken=&Authorization=","urlObject":{"path":["Financial","GetBitcoinBalance"],"host":["https://sandbox.api.anspacepay.com"],"query":[{"key":"ApplicationToken","value":""},{"key":"Authorization","value":""}],"variable":[]}},"response":[],"_postman_id":"917d6db3-4fe7-490b-b62e-e65ad3daa52c"}],"id":"904893e2-7acb-4a03-988f-147a43176b24","description":"API Financial provides the following endpoints:
\ngetRealBalanceBySummary - Returns a complete summary of the current balance of transactional and proprietary accounts. This endpoint requires authentication via ApplicationToken, Authorization, and digitalSignature.
getRealBalanceByDate - Allows you to see the opening and closing balance of transactional and proprietary accounts for a specific date (in YYYY-MM-DD BRT format). This endpoint also requires authentication with ApplicationToken, Authorization, and digitalSignature.
getRealBalance - Returns the current balance of the transactional account, allowing a quick and simplified query.
\npostRebalancingAccounts - Synchronizes the balance of the graphic accounts with the transactional account, making adjustments to the proprietary account according to the value specified (amountGraphicAccounts).
Headers:
\nPending - If there is no pending payment date
Canceled - If it has a cancellation date
Expired - Expiration date less than current date
Paid - If you have a payment date
Unknown - If none of the other conditions.