Skip to main content
POST
/
payments
/
{id}
/
refund
Refund a payment
curl --request POST \
  --url https://api.sandbox.primer.io/payments/{id}/refund \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "amount": 42,
  "orderId": "order-1234-refund",
  "reason": "Customer returned order #1234."
}
'
{
  "id": "kHdEw9EG",
  "date": "2021-02-21T15:36:16.367687",
  "status": "SETTLED",
  "orderId": "order-abc",
  "customerId": "customer-123",
  "currencyCode": "EUR",
  "amount": 42,
  "paymentMethod": {
    "paymentMethodToken": "heNwnqaeRiqvY1UcslfQc3wxNjEzOTIxNjc4",
    "isVaulted": true,
    "descriptor": "Purchase: Socks",
    "analyticsId": "VtkMDAxZW5isH0HsbbNxZ3lo",
    "paymentMethodType": "PAYMENT_CARD",
    "paymentMethodData": {
      "first6Digits": "411111",
      "last4Digits": "1111",
      "expirationMonth": "12",
      "expirationYear": "2030",
      "cardholderName": "John Biggins",
      "network": "Visa",
      "isNetworkTokenized": false,
      "binData": {
        "network": "VISA",
        "regionalRestriction": "UNKNOWN",
        "accountNumberType": "UNKNOWN",
        "accountFundingType": "UNKNOWN",
        "prepaidReloadableIndicator": "NOT_APPLICABLE",
        "productUsageType": "UNKNOWN",
        "productCode": "VISA",
        "productName": "VISA"
      }
    }
  },
  "processor": {
    "name": "STRIPE",
    "processor_merchant_id": "acct_stripe_1234",
    "amountCaptured": 42,
    "amountRefunded": 42
  },
  "transactions": [
    {
      "type": "SALE",
      "processorStatus": "SETTLED",
      "processorName": "STRIPE",
      "processorMerchantId": "acct_stripe_1234",
      "processorTransactionId": "54c4eb5b3ef8a"
    },
    {
      "type": "REFUND",
      "processorStatus": "SETTLED",
      "processorName": "STRIPE",
      "processorMerchantId": "acct_stripe_1234",
      "processorTransactionId": "54c4eb5b3ef8a",
      "reason": "Customer returned order #1234."
    }
  ],
  "customer": {
    "email": "customer123@gmail.com"
  },
  "metadata": {
    "productId": 123,
    "merchantId": "a13bsd62s"
  }
}

Authorizations

​
X-API-KEY
string
header
required

Headers

​
X-Idempotency-Key
string

Optional key to make the request idempotent. Enables a safe retry of a request without risking the user being charged or refunded multiple times. The idempotency key must be generated by the client and needs to be unique for every new request.

Path Parameters

​
id
string
required

ID of payment to refund.

Body

application/json
​
amount
integer<int64>

The amount you would like to refund the customer, in minor units. e.g. for $7, use 700.

Defaults to remaining non-refunded amount.

Required range: x >= 0
​
orderId
string

Optionally you can pass a specific order ID for the refund.

By default this will be set to the original orderId given on payment creation.

​
reason
string

You can optionally specify a reason for the refund. This is for your own records.

Response

Successful Response

​
id
string

The unique payment ID.

You can use this ID to retrieve the payment details, or perform downstream operations.

​
date
string<date-time>

The date and time at which the payment was created in UTC format.

​
status
enum<string>

See the payment status table for more information.

Available options:
PENDING,
FAILED,
AUTHORIZED,
SETTLING,
PARTIALLY_SETTLED,
SETTLED,
DECLINED,
CANCELLED
​
orderId
string

Your reference for the payment.

​
currencyCode
string

The 3-letter currency code in ISO 4217 format. e.g. use USD for US dollars.

​
amount
integer<int64>

The amount you charged the customer, in minor units.

Required range: x >= 0
​
order
Order Details · object

More information associated with the order.

​
customerId
string

The unique identifier for your customer.

​
customer
Customer Details · object

More information associated with the customer.

​
metadata
Payment Metadata · object

Additional data to be used throughout the payment lifecycle.

​
paymentMethod
Payment Method Options · object

The payment method options provided in the request, as well as the token used to process the payment.

​
processor
Processor Information · object

More information associated with the payment processor, including the processor name.

​
requiredAction
Required action · object

Required action to perform in order to resume the payment workflow. This can be requiring a 3DS check from the customer for instance.

​
statusReason
Status Reason · object

Check this field for more information regarding the payment's status. This is especially useful when the status is DECLINED or FAILED.

​
transactions
TransactionOverviewAPISchema · object[]

A list summarizing the transactions that occurred while processing the payment.

Note: a refund is a separate transaction and so will appear in this transactions list if a refund was performed.