Apple Pay Source

1min

Types with ? at the end are nullable.
Field
Type
Description
type
string
The type of payment source. Should be “applepay”.
company
string?
Card scheme of the payment source. One of:
mada
visa
master
amex
name
string?
Always null for Apple Pay.
number
string
Masked card number in the following format:
XXXX-XXXX-XXXX-1111
Note that the last 4 digits are sometime available depending on the merchant integration.
dpan
string?
Masked DPAN (Device Primary Account Number). The format is:
4111-11XX-XXXX-1111
DPAN is only available when the token is successfully decrypted.
gateway_id
string?
Payment ID within the acquirer gateway, for example: MPGS Order ID.
reference_number
string?
RRN or retreival reference number.
message
string?
Human readable string denoting the status or error of the payment.
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 DPAN.
issuer_country
string?
Issuer country of the DPAN.
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.
﻿

Field	Type	Description
type	string	The type of payment source. Should be “applepay”.
company	string?	Card scheme of the payment source. One of: mada visa master amex
name	string?	Always null for Apple Pay.
number	string	Masked card number in the following format: XXXX-XXXX-XXXX-1111 Note that the last 4 digits are sometime available depending on the merchant integration.
dpan	string?	Masked DPAN (Device Primary Account Number). The format is: 4111-11XX-XXXX-1111 DPAN is only available when the token is successfully decrypted.
gateway_id	string?	Payment ID within the acquirer gateway, for example: MPGS Order ID.
reference_number	string?	RRN or retreival reference number.
message	string?	Human readable string denoting the status or error of the payment.
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 DPAN.
issuer_country	string?	Issuer country of the DPAN.
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.

Updated 22 Apr 2024

Did this page help you?

Credit Card Source

STC Pay Source