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

self string

URL for this set

next string

URL for the next set

note string

URL to call for the next set

meta

object

items integer

Number of items in the response

count integer

Total count of items

limit string

Limit set for the number of items

more boolean

Indicates if there are more items

data

object[]

Array [

id string

Payment transaction identification code

attributes

object

billingAddress

object

zip string

The card holder’s zip or postal code

country string

The card holder’s home country

state string

The card holder’s home state

line2 string

The card holder’s street address (line 2)

city string

The card holder’s home city

line1 string

The card holder’s street address (line 1)

card

object

number string

The unique number assigned to an account

holder string

The first and last name on the account

expiry string

The expiration date of the payment method

code string

The three-character CVV2 code

created date-time

The time/date when this transaction was created

merchantId string

The merchant ID that this transaction belongs to

paymentType string

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

transaction

object

amount string

The transaction amount in dollars and cents

currency string

The currency used for the transaction

invoice string

The invoice number for the transaction

code string

The banking entity response code

message string

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-20T20:33:57.180Z",
        "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"
  }
}

Loading...