Skip to main content

Payment Method

Object

NameTypeMandatoryDescription
classstringYThe type of object which is being returned. In this case it will be payment_method.
typestringNThe payment method type. See types
displaystringNA payment method-specific string that can be used to identify the payment method used.
validation_statusstringNThe validation status. Currently our system only performs card validation. See validation statuses
validation_dateunix timestampNThe last validation date if validation is enabled for your account.
invalid_reasonstringNIf the validation status is invalid this field will specify the reason. See invalid reasons)
detailsarrayNThe payment method details object. The parameters returned differ according to the payment method type. See details.

Payment Method types

TypeDescription
CREDITCARDCredit cards
IDEALPayments through bank accounts
SOFORT_BANKINGPayments through bank accounts
SEPA_DIRECT_DEBITPayments through bank accounts
ANCV_CVCOANCV
OPENBANKINGPayments through Open Banking

Validation statuses

StatusFinalDescription
NOT_VALIDATEDYThe payment method has not been validated
VALIDYValidation performed and the payment method is valid.
INVALIDYValidation performed and the payment method is invalid.
NOT_SUPPORTEDYOur system cannot perform validation on this specific payment method.
ERRORNAn error occurred while attempting the card validation

Invalid reasons

Currently this section is only relevant for card validation and card marked as INVALID.

ReasonDescription
HARD_DECLINEValidation failed because the card is flagged as lost or stolen
SOFT_DECLINEValidation failed because it has been declined by the acquiring bank, mostly due to exceeding card limits or invalid card holder details.
INSUFFICIENT_FUNDSWe attempted to validate the card but the validation failed because of insufficient funds
SCHEME_NOT_SUPPORTEDValidation failed because the scheme is not supported
PREPAID_NOT_SUPPORTEDValidation failed because prepaid cards are not supported
BIN_NOT_SUPPORTEDValidation failed because the card’s bin is not supported

Payment Method details

NameTypeMandatoryDescription
classstringYThe type of object which is being returned. In this case it will be payment_method_details.

Method-specific parameters

Method: CREDITCARD

NameTypeDescription
fingerprintstringThe credit card fingerprint Uuid.
holderstringCardholder name.
schemestringCredit card scheme. See the section below.
exp_monthstringCredit card expire month (ex: 01).
exp_yearstringCredit card expire year (ex: 2016).

Card schemes

Scheme
VISA
MASTERCARD
VISAELECTRON
AMERICANEXPRESS
DINERSCLUB
DISCOVER
JCB
MAESTROINT
SOLO
SWITCH
LASER
UNIONPAY
DEBITMASTERCARD
ENROUTE
ATM
DUET
GECAPITAL
PLATIMA
PPT
RBSGIFTCARD
PRIVATELABELCARD
UKFUELCARD
AIRPLUS
ATOSPRIVATELABEL
HIPERCARD
ELO
DANKORT
AURA
RUPAY
BANKCARD
CHJONESFUELCARD
REDFUELCARD
EUROSHELLFUELCARD
LOYALTYCARD
BPFUELCARD
PHHFUELCARD
STARREWARDS
REDLIQUIDFUELCARD
LUKOILFUELCARD
UNKNOWN

Method: SEPA_DIRECT_DEBIT | IDEAL | SOFORT_BANKING

NameTypeDescription
fingerprintstringThe bank account fingerprint Uuid.
holderstringThe bank account holder name.
ibanstringThe bank account IBAN code.
bicstringThe bank account BIC/SWIFT code.

Method: ANCV_CVCO

NameTypeDescription
cvco_referencestringThe reference of the transaction for the processor.
walletstringThe reference of the wallet/buyer for the processor.

Example

{
"class":"payment_method",
"type":"CREDITCARD",
"display":"4111-11xx-xxxx-1111",
"validation_status": "VALID",
"validation_date":"1443607554",
"invalid_reason": null,
"details":
{
"class":"payment_method_details",
"holder":"Card Holder Name",
"scheme": "VISA",
"exp_month":"01",
"exp_year":"2016"
}
}