Find refunds of payment by ID
GET- payments/{paymentId}/refunds (1)
AUTHORIZATIONS (2)
-
Sandbox server (uses test data)
https://api.sandbox.payerly.tech/v1/payments/{paymentId}/refunds
Production server (uses live data)
https://api.payerly.tech/v1/payments/{paymentId}/refunds -
BearerAuth
PATH PARAMETERS
| Parameter | Type | Description |
|---|---|---|
paymentIdrequired |
string | Merchant payment id (must be unique within the merchant site) |
RESPONSE HEADERS:
| Parameter | Type | Description |
|---|---|---|
Date |
string(date-time) | The Date header indicates the server time. |
RESPONSE SCHEMA: application/json
| Parameter | Type | Description |
|---|---|---|
type |
string | Object type (REFUND).Value REFUND |
object |
object | Refund object: - refundId:Merchant refund id- paymentId:Merchant payment id- txnId:Unique transaction id- orderId:Merchant order id- createdAt:Refund created at- callbackUrl:Merchant's URL for callback- amount: - value required : Amount value. - currency required : Amount currency (e.g., "USD", "EUR"). convAmount: - value required : Amount value. - currency required : Amount currency (e.g., "USD", "EUR")- additionalInfo:- rrn - Merchant rrn- customFields: - cf1: Additional field 1 - cf2: Additional field 2 - cf3: Additional field 3 - cf4: Additional field 4 - cf5: Additional field 5- status: - changedAt:Status changed- value:Status value - description:Status description |
error |
object | Error object: - code:Error code- description:Error description- traceId:Unique request trace id (for support requests)- details:Errors details array- value:Error brief - description:Error description- fields:Errors fields array:- name:Filed name - type:Location of field (body, header) - value:Field value |
200
{
"items": [
{
"type": "REFUND",
"object": {
"refundId": "string",
"paymentId": "string",
"txnId": "string",
"orderId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"callbackUrl": "string",
"amount": {
"value": "7635.01",
"currency": "USD"
},
"convAmount": {
"value": "7635.01",
"currency": "USD"
},
"additionalInfo": {
"rrn": "4434636542976"
},
"customFields": {
"cf1": "string",
"cf2": "string",
"cf3": "string",
"cf4": "string",
"cf5": "string"
},
"status": {
"changedAt": "2019-08-24T14:15:22Z",
"value": "string",
"description": "string"
}
},
"error": {
"code": 65535,
"description": "string",
"traceId": "string",
"details": [
{
"value": "string",
"description": "string",
"fields": [
{
"name": "string",
"type": "string",
"value": "string"
}
]
}
]
}
}
]
}