Payments: Refund
This API allows you to refund a payment given a specific id and amount.
Note:
This is a Token Authorized call.
Refund a Payment
POST https://app.sign2pay.com/api/v2/purchases/55fac963e6db9909ba000003/refunds| Parameter | Required | Type | Description |
|---|---|---|---|
| amount | yes | Integer | Amount to refund in cents. |
Request Headers & Body
Accept: */*
Accept-Encoding: gzip, deflate
Content-Type: application/json
Authorization: Token token=2d7c34be6b03de66386e50a962dd4349
Accept-Language: en-us
{"refund": {"amount": 500}}
Response Body
{
"message": "Refund succesfully processed.",
"data": {
"refund": {
"id": "55facb5ee6db990e2e000006",
"created_at": "2015-09-17T16:17:02.270+02:00",
"updated_at": "2015-09-17T16:17:02.270+02:00",
"amount": 500,
"purchase": {
"id": "55fac963e6db9909ba000003",
"created_at": "2015-09-17T16:08:35.511+02:00",
"updated_at": "2015-09-17T16:08:36.543+02:00",
"amount": 500,
"ref_id": "a742e5ba64c887e6314"
},
"entries": [
{
"id": "55facb5ee6db990e2e000007",
"created_at": "2015-09-17T16:17:02.208+02:00",
"updated_at": "2015-09-17T16:17:02.208+02:00",
"type": "refund",
"purchase_id": "55fac963e6db9909ba000003",
"ref_id": "a742e5ba64c887e6314",
"amount": 500
},
{
"id": "55facb5ee6db990e2e000008",
"created_at": "2015-09-17T16:17:02.247+02:00",
"updated_at": "2015-09-17T16:17:02.247+02:00",
"type": "refund_fee",
"purchase_id": "55fac963e6db9909ba000003",
"ref_id": "a742e5ba64c887e6314",
"amount": 25
},
{
"id": "55facb5ee6db990e2e000009",
"created_at": "2015-09-17T16:17:02.267+02:00",
"updated_at": "2015-09-17T16:17:02.267+02:00",
"type": "refund",
"purchase_id": "55fac963e6db9909ba000003",
"ref_id": "a742e5ba64c887e6314",
"amount": -525
}
]
},
"trump": {
"credit_transfer_id": "55facb5e4e69630e42000001"
}
}
}