- Introduction
- Environments
- Authentication
- Webhooks
- Terminal ordering
- Reporting
- Errors
- Getting started
- Payments
- Payment Links
- Webhook subscriptions
- Merchants
- List all merchantsGET
- Register a new merchantPOST
- Connect to a merchantPOST
- Get merchant balanceGET
- Get merchant detailsGET
- Update merchant bank details for receiving payouts. PUT
- Get merchant onboarding linkGET
- Create account session with permissions for the specified embedded components.POST
- Get list of available hardware for given merchant to purchaseGET
- Order terminal hardware for the specified merchant.POST
- List all merchants
- Marketing Deeplinks
- Reports
- Customers
- Subscription Plans
- Subscriptions
- Payments
Refunds a payment
Production Environment
https://api.lopay.com
Production Environment
https://api.lopay.com
POST
/api/1/partner/payment/{id}/refund
Request
Authorization
or
Path Params
Header Params
Body Params application/json
Example
{
"amount": -500
}Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.lopay.com/api/1/partner/payment//refund' \
--header 'x-merchant-id;' \
--header 'Content-Type: application/json' \
--data-raw '{
"amount": -500
}'Responses
🟢200OK
application/json
Body
Example
{
"id": "662a8074-6959-4793-8ac9-a1f03d5f1181",
"status": "refunded",
"type": "card",
"taxes": [
{
"name": "VAT (20%)",
"inclusive": true,
"rate": "20.00",
"amount": {
"units": 500,
"currencyCode": "GBP"
}
}
],
"tip": {
"units": 0,
"currencyCode": "GBP"
},
"subtotal": {
"units": 3000,
"currencyCode": "GBP"
},
"total": {
"units": 3000,
"currencyCode": "GBP"
},
"createdAt": "2023-03-08T23:12:32.686Z",
"updatedAt": "2023-03-09T12:45:00.000Z"
}🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Not Found
🟠422Unprocessable Entity
🔴500Internal Server Error
Modified at 2025-10-30 11:30:45