FAfactorialhr
Banking > CardPayment

Reads a single Card payment

Changed on

Reads a single Card payment

get/api/2026-10-01/resources/banking/card_payments/{id}

Request

  • Base URL
    https://api.factorialhr.com
  • URL
    https://api.factorialhr.com/api/2026-10-01/resources/banking/card_payments/{id}
  • Auth
    API key in header x-api-key

Path parameters

idstring required

An array of card payment IDs to filter by.

Response

OK

idstring required

The ID of the card payment.

card_idstring required

The ID of the card.

amount_centsinteger required

The amount of the card payment.

currencystring required

The currency of the card payment.

merchant_namestring required

The name of the merchant.

merchant_amount_centsinteger required

The amount of the merchant.

merchant_currencystring required

The currency of the merchant.

approvedboolean required

Whether the card payment was approved.

external_created_atstring required

The date and time the card payment was created in the external system.

status'pending' | 'closed' | 'reversed' | 'rejected' required

The status of the card payment.

type'payment' | 'refund' required

The type of the card payment.

exchange_ratenumber required

The exchange rate of the card payment.

rejected_reason'account_disabled' | 'card_active' | 'card_canceled' | 'card_expired' | 'card_inactive' | 'cardholder_blocked' | 'cardholder_inactive' | 'cardholder_verification_required' | 'insecure_authorization_method' | 'insufficient_funds' | 'not_allowed' | 'pin_blocked' | 'spending_controls' | 'suspected_fraud' | 'verification_failed' | 'webhook_approved' | 'webhook_declined' | 'webhook_error' | 'webhook_timeout' | 'authentication_failed' | 'incorrect_cvc' | 'incorrect_expiry' | 'account_compliance_disabled' | 'account_inactive' | 'authorization_controls'

The reason the card payment was rejected.

created_atstring required

The date and time the card payment was created in factorial

Example response

{
  "id": "135",
  "card_id": "123",
  "amount_cents": -1000,
  "currency": "EUR",
  "merchant_name": "Test Merchant",
  "merchant_amount_cents": -1000,
  "merchant_currency": "EUR",
  "approved": true,
  "external_created_at": "2025-01-01T00:00:00.000Z",
  "status": "closed",
  "type": "payment",
  "exchange_rate": 1,
  "rejected_reason": "insufficient_funds",
  "created_at": "2025-01-01T00:00:00.000Z"
}

Changes