API
Payments

Credit Card Source

1min

Types with ? at the end are nullable.

Field

Type

Description

type

string

The type of payment source. Should be “creditcard”.

company

string?

Card scheme of the payment source. One of:

  • mada
  • visa
  • master
  • amex

name

string

Cardholder name.

number

string

Masked card number in the following format:

  • 4111-11XX-XXXX-1111

month

integer

Expiry month

year

integer

Expiry year

gateway_id

string?

Payment ID within the acquirer gateway, for example: MPGS Order ID.

reference_number

string?

RRN or retreival reference number.

token

string?

The card token. Returned only in the Create Payment response when save_card is set to true.

message

string?

Human readable string denoting the status or error of the payment.

transaction_url

string?

Contains a URL to the 3D Secure challenge when available.

response_code

string?

The payment response code from the acquirer gateway.

authorization_code

string?

Authorization code as returned from the acquirer gateway.

issuer_name

string?

Issuer name of the card.

issuer_country

string?

Issuer country of the card.

issuer_card_type

string?

Card type can be one of the following:

  • debit
  • credit
  • charge_card
  • unspecified

issuer_card_category

string?

Indicates the card category like Platinum, Signature and so on.

This is a free text field and can contain any value.