Get Payment Status by Id

GET 
/payments/status/:cardpaymentId

Use this endpoint to retrieve data from an existing transaction.

Note

There are no request parameters for this endpoint, besides the paymentId in the URI.

Request

Path Parameters

cardpaymentId stringrequired
Unique identifier of the payment.
Example: {{cardpaymentId}}

Header Parameters

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

Responses

200

OK

application/json

Schema

Schema

links

object

selfstring

URL for this set

nextstring

URL for the next set

notestring

URL to call for the next set

meta

object

itemsinteger

Number of items in the response

countinteger

Total count of items

limitstring

Limit set for the number of items

moreboolean

Indicates if there are more items

data

object[]

Array [

idstring

Payment transaction identification code

attributes

object

billingAddress

object

zipstring

The card holder’s zip or postal code

countrystring

The card holder’s home country

statestring

The card holder’s home state

line2string

The card holder’s street address (line 2)

citystring

The card holder’s home city

line1string

The card holder’s street address (line 1)

card

object

numberstring

The unique number assigned to an account

holderstring

The first and last name on the account

expirystring

The expiration date of the payment method

codestring

The three-character CVV2 code

createddate-time

The time/date when this transaction was created

merchantIdstring

The merchant ID that this transaction belongs to

paymentTypestring

The type of payment (card, ach, token, ...)

transaction

object

amountstring

The transaction amount in dollars and cents

currencystring

The currency used for the transaction

invoicestring

The invoice number for the transaction

codestring

The banking entity response code

messagestring

The status of the transaction

]

Example (from schema)

{
  "links": {
    "self": "string",
    "next": "string",
    "note": "string"
  },
  "meta": {
    "items": 0,
    "count": 0,
    "limit": "string",
    "more": true
  },
  "data": [
    {
      "id": "string",
      "attributes": {
        "billingAddress": {
          "zip": "string",
          "country": "string",
          "state": "string",
          "line2": "string",
          "city": "string",
          "line1": "string"
        },
        "card": {
          "number": "string",
          "holder": "string",
          "expiry": "string",
          "code": "string"
        },
        "created": "2024-07-29T15:51:28.071Z",
        "merchantId": "string",
        "paymentType": "string",
        "transaction": {
          "amount": "string",
          "currency": "string",
          "invoice": "string",
          "code": "string",
          "message": "string"
        }
      }
    }
  ]
}

ok

{
  "links": {
    "self": ""
  },
  "data": {
    "id": "paymentId",
    "txnStatus": "CCDebitPending",
    "type": "payments"
  }
}

Result

{
  "links": {
    "self": "x"
  },
  "data": {
    "id": "{paymentId}",
    "attributes": {
      "merchantId": "{merchantId}",
      "created": "2019-10-10T18:49:35.311Z",
      "miscData": "test note",
      "billingAddress": {
        "zip": "90210",
        "country": "USA",
        "state": "CA",
        "line2": "Suite 007",
        "city": "Los Angeles",
        "line1": "21 Jump Street"
      },
      "transaction": {
        "amount": "500",
        "code": "0",
        "authCode": "A11111",
        "avsResult": "T",
        "gross": "500",
        "rate": "2.95",
        "fee": "35",
        "currency": "USD",
        "invoice": "123456",
        "message": "Success",
        "net": "450",
        "grossMinusNet": "50"
      },
      "card": {
        "number": "xxxx1685",
        "holder": "Jane Doe",
        "expiry": "0220",
        "code": "xxx"
      },
      "paymentType": "card"
    },
    "type": "payments"
  }
}