The service consists of providing a service that returns the image of the proof of transaction of users' operations in base64 format.
Important:
For consultation in a production environment, it will be necessary to inform the IP range to be
released by our technical team.
The service allows the return of images of proof of payment transaction in base64 format, ensuring secure and efficient access to data of users. We use best practices in security, ensuring the integrity and confidentiality of information processed.
Endpoint: POST https://{BASEURL}/receipts/merchant/cash-out/generate
Headers: Content-Type: application/x-www-form-urlencoded
| Type | description |
|---|---|
| MERCHANT_ID | merchant ID at pay2free |
| TRANSACTION_ID | transaction ID on pay2free |
| API_KEY | API Key (will not be the same as the transactionId) |
| baseurl | URL of the access base of the environment to be used. |
cURL
curl --location
'https://<baseurl>/receipts/merchant/cash-out/generate'
--header 'Content-Type: application/json'
--header 'x-pixer-api-key: Api-Key <API_KEY>'
--data '{
"merchant":<MERCHANT_ID>,
"transactionId": <TRANSACTION_ID>
}'
Response:
{
"transactionId": <ID_TRANSACTION>,
"status": <empty OR any of the statuses below>,
"invoice": <empty or BASE64>,
"datetimerequest": "2024-07-12T15:48:55.847Z",
"datetimepayed": <empty or DateTime "2024-07-12T15:49:14.027Z">
}
Description:
0 - Transaction not found
1 - Requested
2 - Failed/Rejected/Error
3 - Processing
4 - Completed
- Transaction found
- Transaction completed
- Callback sent to the platform and responded to with success or error
- Generated receipt
- TransactionID not found or with status other than completed