Skip to main content

Refund Payments

Refunds API lets developers refund payments. Refunds use your available MobilePay balance. If your available balance doesn't cover the amount of the refund, it will fail. You can only refund payments with the state captured and within 30 days of the original payment date.

Common refund scenarios include:

  • Refund all or a portion of payment.
  • Multiple partial refunds of payment.

Refund Payment#

Refund payment
curl \  -X POST \  -H 'x-ibm-client-id: {CLIENT_ID}' \  -H 'Authorization: Bearer {API_KEY}' \  -H 'Content-Type: application/json' \  -d '{    "idempotencyKey": "{UUID}",    "paymentId": "{PAYMENT_ID}",    "amount": 500,    "reference": "{YOUR_UNIQUE_KEY}",    "description": "Lorem ipsum"  }'

When MobilePay receives the request, it begins the refund process. The response and its status code will indicate if a refund was successful. The following is an example response:

Response JSON example
{  "refundId": "7576910d-9789-4fef-a72e-877d89afec94",  "paymentId": "186d2b31-ff25-4414-9fd1-bfe9807fa8b7",  "amount": 500,  "description": "Lorem ipsum",  "reference": "order-212-32",  "createdOn": "2021-07-19T12:42:38Z",  "remainingAmount": 750}

remainingAmount will be included in successful refund response once, for reasons when you might need to do multiple refunds.

Retrieve Refund Information#

After you refund a payment there might be a need to get refund information.

Retrieve refund
curl{refundid} \  -X GET \  -H 'x-ibm-client-id: {CLIENT_ID}' \  -H 'Authorization: Bearer {API_KEY}' \  -H 'Content-Type: application/json'

Or to see all refunds.

List refunds
curl \  -X GET \  -H 'x-ibm-client-id: {CLIENT_ID}' \  -H 'Authorization: Bearer {API_KEY}' \  -H 'Content-Type: application/json'
Response JSON example
{  "pageSize": 48649663,  "nextPageNumber": 31,  "refunds": [    {      "refundId": "7576910d-9789-4fef-a72e-877d89afec94",      "paymentId": "186d2b31-ff25-4414-9fd1-bfe9807fa8b7",      "amount": 500,      "description": "Lorem ipsum",      "reference": "order-212-32",      "createdOn": "2021-07-19T12:42:38+00:00"    }  ]}