FAfatzebra

Refund a capture

Changed on
post/paypal/captures/{id}/refund

Request

  • Base URL
    https://gateway.pmnts-sandbox.io/v1.0
  • URL
    https://gateway.pmnts-sandbox.io/v1.0/paypal/captures/{id}/refund
  • Auth
    HTTP basic

Path parameters

idstring required

The ID of the capture to be refunded

Headers

Content-Typestring

application/json

Request body

amountinteger

Amount to be refunded in the smallest unit of the currency.

note_to_payerstring

A note to be attached with the refund. Will be visible to the customer

Response

200

successfulboolean
testboolean

Example response

{
  "successful": true,
  "response": {
    "id": "071-PPR-TIBSYRFOTPSSRGDZ",
    "amount": 1,
    "refunded": "Approved",
    "message": "Approved",
    "transaction_id": "071-PPR-TIBSYRFOTPSSRGDZ",
    "currency": "AUD",
    "successful": true,
    "transaction_date": "2020-08-31T14:59:53+10:00",
    "status": "Completed",
    "note_to_payer": "1 cent",
    "invoice_id": "071-PPR-TIBSYRFOTPSSRGDZ",
    "decimal_amount": 0.01,
    "seller_payable_net_amount": 1,
    "balance_available_for_refund": 198,
    "capture": "071-PPC-9JNQNPWCD3FSOHDG",
    "order": "071-PPO-ZVCVMDEFCBX86RX2"
  },
  "test": true
}

Changes