Refund Payments

POST 
/payments

Use to endpoint to refund a payment.

Request

Header Parameters

Authorization string
appToken created by /auth/token Format: Bearer xxxxxx...
Example: Bearer <appToken>

application/json

Body

required

data

object

A key for grouping different types of API data.

typestring

The type of transaction.

Example: payments

attributes

object

A key for grouping payment identification data.

paymentTypestring

The type of payment transaction.

Possible values: [cardRefund]

Example: cardRefund

merchantIdstring

The merchant account number.

Example: {{merchantId}}

miscDatastring

Optional additional information to store with the call (optional).

Example: Customer Initiated Refund

transaction

object

A key for grouping payment transaction data. Required for all payment types except secondSplit.

amountstring

The transaction amount in cents.

Example: 500

currencystring

The three-character code.

Example: USD

invoicestring

The invoice number for the transaction.

Example: 123456

originalTransaction

object

A key for referencing the original split transaction.

idstring

The ID of the original split transaction.

Example: {{cardpaymentId}}

Responses

201

Created

application/json

Schema

Schema

links

object

selfstring

URL for the current resource.

data

object

typestring

The type of transaction.

idstring

The payment transaction identification code.

attributes

object

A key for grouping payment identification data.

paymentTypestring

The application key.

transaction

object

A key for grouping payment identification data.

codestring

The banking entity response code.

messagestring

The status of the transaction.

amountstring

The transaction amount in dollars and cents.

invoicestring

The invoice number for the transaction.

currencystring

The currency used for the transaction.

Example (from schema)

{
  "links": {
    "self": "string"
  },
  "data": {
    "type": "string",
    "id": "string",
    "attributes": {
      "paymentType": "string",
      "transaction": {
        "code": "string",
        "message": "string",
        "amount": "string",
        "invoice": "string",
        "currency": "string"
      }
    }
  }
}

Result

{
  "links": {
    "self": "x"
  },
  "data": {
    "type": "payments",
    "id": "{paymentId}",
    "attributes": {
      "paymentType": "cardRefund",
      "transaction": {
        "code": "0",
        "message": "Success",
        "amount": "500",
        "invoice": "123456",
        "currency": "USD",
        "authCode": "A11111",
        "avsResult": "T",
        "gross": "500",
        "net": "450",
        "grossMinusNet": "50",
        "fee": "35",
        "rate": "2.95"
      }
    }
  }
}