Initiate Refund
curl --request POST \
--url https://api.atoa.me/api/refund \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"paymentRequestId": "<string>",
"amount": 123,
"currency": "<string>",
"refundNotes": "<string>"
}'{
"refundId": "a7c82e45-9f31-42b6-8d15-7e63f1b92c4d",
"paymentRequestId": "5e8b2c73-1f64-4a97-9c38-d2f6ae15b8c2",
"paymentIdempotencyId": "ATOA1234567890123",
"status": "INITIATED",
"paidAmount": "250.75",
"refundAmount": "25.50",
"currency": "GBP",
"refundNotes": "Customer requested refund",
"orderId": "987654321",
"createdAt": "2023-11-15T14:32:45.789Z",
"updatedAt": "2023-11-15T14:32:45.789Z"
}
Instant refunds are only available for selected merchants with same day payout functionality. Please reach out to support if you want to enable refunds in your account.
This API creates a refund for a specific successful payment. The refunded amount is credited to the customer’s source bank account via a bank transfer within 30 minutes, provided that you have sufficient balance available in your account.
Authorization
Bearer <token>
Request Body Schema
The payment request ID of the transaction that needs to be refunded. Only
completed payments can be refunded.
Note: If you need to know how to generate a payment request ID, refer to
Process payment
.
Amount to be refunded (should not exceed the original transaction amount). Decimal values are allowed. Minimum value is 1.
The currency of the refund amount. If not specified, the currency of the original transaction will be used. Example: “GBP”.
Refund reason for your internal reference.
Response
The unique identifier for the refund transaction. You can use this ID to cancel the refund later via the Cancel Refund API.
The ID of the original payment request that is being refunded.
The idempotency ID of the original payment, used to ensure the payment was processed only once.
The current status of the refund request (e.g., “INITIATED”, “COMPLETED”, “FAILED”).
The original amount that was paid in the transaction being refunded.
The amount being refunded to the customer.
The currency code for the refund transaction (e.g., “GBP”).
Notes or reason provided for the refund.
The order ID associated with the original transaction.
The timestamp when this refund request was last updated.
The timestamp when this refund request was created in the system.
curl --request POST \
--url https://api.atoa.me/api/refund \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"paymentRequestId": "<string>",
"amount": 123,
"currency": "<string>",
"refundNotes": "<string>"
}'{
"refundId": "a7c82e45-9f31-42b6-8d15-7e63f1b92c4d",
"paymentRequestId": "5e8b2c73-1f64-4a97-9c38-d2f6ae15b8c2",
"paymentIdempotencyId": "ATOA1234567890123",
"status": "INITIATED",
"paidAmount": "250.75",
"refundAmount": "25.50",
"currency": "GBP",
"refundNotes": "Customer requested refund",
"orderId": "987654321",
"createdAt": "2023-11-15T14:32:45.789Z",
"updatedAt": "2023-11-15T14:32:45.789Z"
}