Approve refund
Refunds
The refund API allows you to manipulate refunds that have been created on a payment. Funds will be refunded to either the card or wallet that was originally charged or to a bank account if a direct refund is not possible
Request
Approve a created, unprocessed, refund resource. This is the second half of the two-step refund flow, where first you create a refund and review it before instructing us to process the refund. Approving the refund instructs us to process the submitted refund.
PayloadApproveRefundRequest
|
Properties
|
|||
| Property | Type | Required | Details |
|---|---|---|---|
| amount | integer (12) | no | read close |
|
close
DescriptionRefund amount to be approved
|
|||
Request example
This scenario you will probably use the most
-
var body = new ApproveRefundRequest(); body.Amount = 199L; await client.V1.WithNewMerchant("merchantId").Refunds.Approve("refundId", body);
Responses
Please find below an overview of the possible responses.
Response 204 - No content
For every successfully approved refund resource a HTTP 204 response is returned.
Response 400 - Bad requestErrorResponse
|
Properties
|
|||
| Property | Type | Required | Details |
|---|---|---|---|
| errorId | string | yes | read close |
|
close
DescriptionUnique reference, for debugging purposes, of this error response
|
|||
| array of object | yes | read close | |
|
close
DescriptionList of one or more errors
|
|||
| object | no | read close | |
| category | string | no | read close |
|
close
DescriptionCategory the error belongs to. The category should give an indication of the type of error you are dealing with.
Possible values:
|
|||
| code | string | yes | read close |
|
close
DescriptionError code
|
|||
| httpStatusCode | integer | no | read close |
|
close
DescriptionHTTP status code for this error that can be used to determine the type of error
|
|||
| id | string | no | read close |
|
close
DescriptionID of the error. This is a short human-readable message that briefly describes the error.
|
|||
| message | string | no | read close |
|
close
DescriptionHuman-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
|
|||
| propertyName | string | no | read close |
|
close
DescriptionReturned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query. Some common examples:
|
|||
| requestId | string | no | read close |
|
close
DescriptionID of the request that can be used for debugging purposes
|
|||
Response example
This scenario you will probably use the most
-
{ "errorId" : "15eabcd5-30b3-479b-ae03-67bb351c07e6-00000092", "errors" : [ { "code" : "20000000", "propertyName" : "bankAccountBban.accountNumber", "message" : "PARAMETER_NOT_FOUND_IN_REQUEST" } ] }