Create and manage one-time payment transactions
Easypay Payments API (2.0)
Transferir a descrição da OpenAPI
Visão geral
Easypay Documentation
Licença
Idiomas
Servidores
Sandbox
https://api.test.easypay.pt/2.0
Production
https://api.prod.easypay.pt/2.0
- Sandboxhttps://api.test.easypay.pt/2.0/void/{id}
- Productionhttps://api.prod.easypay.pt/2.0/void/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.test.easypay.pt/2.0/void/{id}' \
-H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
-H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92'OK
Indicates the current status of the refund. Possible values include:
- processing: This is the initial state, and it means that the void is queued.
- success: The void has been completed successfully.
- failed: The void could not be completed due to an error or issue. This field provides a clear indication of the current state of the refund, helping users understand its progress and outcome.
Enum"success""processing""failed"
A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced.
A customizable text field for users to input their own identifier for the resource. This can be any string that helps the user uniquely identify or reference the resource in their own system.
A text field that describes the transaction as it will appear on the end user's account statement. This is typically used to provide clear, recognizable information about the payment, such as "Payment of Invoice Nº 1982652" or "Ticket for Queen".
Resposta
application/json
{ "status": "success", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "transaction_key": "string", "descriptive": "string", "authorisation": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "status": "waiting", "key": "string", "customer": { … }, "method": { … }, "currency": "EUR", "value": 15.78 } }
Corpoapplication/jsonobrigatório
Void details
This will appear in the bank statement/mbway application.
- Sandboxhttps://api.test.easypay.pt/2.0/void/{id}
- Productionhttps://api.prod.easypay.pt/2.0/void/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api.test.easypay.pt/2.0/void/{id}' \
-H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
-H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92' \
-H 'Content-Type: application/json' \
-d '{
"descriptive": "string",
"transaction_key": "string"
}'Created
An array of human-readable messages included in the response. These messages provide detailed information about the success of the operation or explain the reasons for any failure. This field is always present in the response to ensure clarity and transparency regarding the outcome of the API request.
Exemplo: ["Your request was successfully created"]
Resposta
application/json
{ "status": "ok", "message": [ "Your request was successfully created" ], "id": "8010e7d5-9985-4ae3-b1bf-6b70019439c7" }