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.

type string

The type of transaction.

Example: payments

attributes

object

A key for grouping payment identification data.

paymentType string

The type of payment transaction.

Possible values: [cardRefund]

Example: cardRefund

merchantId string

The merchant account number.

Example: {{merchantId}}

miscData string

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.

amount string

The transaction amount in cents.

Example: 500

currency string

The three-character code.

Example: USD

invoice string

The invoice number for the transaction.

Example: 123456

originalTransaction

object

A key for referencing the original split transaction.

id string

The ID of the original split transaction.

Example: {{cardpaymentId}}

Responses

201

Created

application/json

Schema

Schema

links

object

self string

URL for the current resource.

data

object

type string

The type of transaction.

id string

The payment transaction identification code.

attributes

object

A key for grouping payment identification data.

paymentType string

The application key.

transaction

object

A key for grouping payment identification data.

code string

The banking entity response code.

message string

The status of the transaction.

amount string

The transaction amount in dollars and cents.

invoice string

The invoice number for the transaction.

currency string

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"
      }
    }
  }
}