Create Payments

POST 
/payments

Use this endpoint to create 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 strings

The type of payment transaction.

Possible values: [tokenv3]

Example: tokenv3

merchantId string

The merchant account number.

Example: {{merchantId}}

miscData string

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

Example: {"email":"[email protected]","originIp":"127.0.0.1","customerIp":"127.0.0.1","rawData":"Lorem ipsum"}

transaction

object

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

amount integer

The transaction amount in cents.

Example: 1

currency string

The three-character code.

Example: USD

invoice string

The invoice number for the transaction.

Example: PAYMENT-TOKEN-7

token

object

A key for grouping payment token information.

holder string

The first and last name on the account.

Example: Tommy

tokenId string

The Token ID retrieved from the embedded checkout.

Example: {{token}}

expiry string

The expiration date of the payment method.

Example: 0229

useAVS boolean

True/False for requiring a ZIP match (or greater) to capture the payment.

Example: true

billingAddress

object

A key for grouping billing address data.

line1 string

The card holder’s street address (optional but recommended).

Example: 21 Jump Street

line2 string

The card holder’s additional street address information (optional but recommended).

Example: Suite 007

city string

The card holder’s home city (optional but recommended).

Example: Los Angeles

state string

The card holder’s home state (optional but recommended).

Example: CA

zip string

The card holder’s zip or postal code (optional, but recommended.)

Example: 832044716

country string

The card holder’s home country (optional but recommended).

Example: USA

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": "card",
      "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"
      }
    }
  }
}