Card Payments

Card payments are transactions initiated when a cardholder uses an issued card e.g to make an online purchase.

Retrieve card payments

Method	Description	Endpoint
`GET`	List card payment	`/api/v1/card-payments`
`GET`	Fetch card payment by ID	`/api/v1/card-payment/:paymentID`

A sample card payment details is given below:

{
   "id":"17846483290-anc_card_pymt",
   "type":"CardPayment",
   "attributes":{
      "createdAt":"2026-07-21T15:17:08",
      "amounts":{
         "authorized":0,
         "reversed":0,
         "adjusted":0,
         "settled":100,
         "refundAuthorized":100,
         "refunded":0
      },
      "merchant":{
         "name":"MERCADONA SA             VALENCIA   ES",
         "identifier":"MERCADONA-00142",
         "categoryCode":"5411",
         "countryCode":"724"
      },
      "currency":"USD",
      "terminalId":"TRM00142",
      "transactionDate":"2026-04-14T09:46:00",
      "networkIdentifier":{
         "transactionIdentifier":"000014525",
         "authorizationCode":"050012"
      },
      "updatedAt":"2026-07-21T15:19:15",
      "status":"REFUNDED"
   },
   "relationships":{
      "organization":{
         "data":{
            "id":"16538589610-anc_og",
            "type":"Organization"
         }
      },
      "history":{
         "data":[
            {
               "id":"17840284160-anc_card_pymt_his",
               "type":"CardPaymentHistory"
            },
            {
               "id":"17846552011-anc_card_pymt_his",
               "type":"CardPaymentHistory"
            }
         ]
      },
      "card":{
         "data":{
            "id":"178402131572-anc_card",
            "type":"Card"
         }
      }
   }
}

Field	Type	Description
id	string	Unique identifier for the card payment.
type	string	The resource type. `CardPayment`
createdAt	string	Timestamp for when the payment record was created.
updatedAt	string	Timestamp for the most recent update to the payment record.
transactionDate	string	Timestamp for when the transaction actually occurred at the merchant.
currency	string	The currency the transaction was processed in.
status	string	The current lifecycle status of the payment (e.g. `SETTLED`, `REFUNDED`).
terminalId	string	Identifier for the terminal used to process the transaction.
amounts.authorized	integer	The amount currently held under authorization.
amounts.reversed	integer	The amount that has been reversed from the original authorization.
amounts.adjusted	integer	The amount adjusted after authorization, if any.
amounts.settled	integer	The final amount settled for this payment.
amounts.refundAuthorized	integer	The amount authorized for refund.
amounts.refunded	integer	The amount actually refunded to the cardholder.
merchant.name	string	The merchant's name as it appears on the transaction.
merchant.identifier	string	Unique identifier for the merchant.
merchant.categoryCode	string	The merchant category code (MCC) for the transaction.
merchant.countryCode	string	The merchant's country code.
transactionIdentifier	string	The card network's identifier for this transaction.
authorizationCode	string	The authorization code returned by the card network.
relationships.organization	object	The organization the card payment belongs to.
relationships.card	object	The card used for the transaction.
relationships.history	array	Related `CardPaymentHistory` records tracking status changes for this payment.

Card Payment Lifecycle

Status	Description
`PENDING`	Payment processing has started but no final authorization outcome is available.
`AUTHORIZED`	The issuer approved the payment and funds may be held.
`PARTIALLY_REVERSED`	Part of the authorized amount has been released or reversed.
`REVERSED`	The authorization was fully reversed.
`SETTLED`	The final payment amount has been settled.
`DECLINED`	The payment was not authorized.