Payment Method
Object
| Name | Type | Mandatory | Description |
|---|---|---|---|
| class | string | Y | The type of object which is being returned. In this case it will be payment_method. |
| type | string | N | The payment method type. See types |
| display | string | N | A payment method-specific string that can be used to identify the payment method used. |
| validation_status | string | N | The validation status. Currently our system only performs card validation. See validation statuses |
| validation_date | unix timestamp | N | The last validation date if validation is enabled for your account. |
| invalid_reason | string | N | If the validation status is invalid this field will specify the reason. See invalid reasons) |
| details | array | N | The payment method details object. The parameters returned differ according to the payment method type. See details. |
Payment Method types
| Type | Description |
|---|---|
| CREDITCARD | Credit cards |
| IDEAL | Payments through bank accounts |
| SOFORT_BANKING | Payments through bank accounts |
| SEPA_DIRECT_DEBIT | Payments through bank accounts |
| ANCV_CVCO | ANCV |
| OPENBANKING | Payments through Open Banking |
Validation statuses
| Status | Final | Description |
|---|---|---|
| NOT_VALIDATED | Y | The payment method has not been validated |
| VALID | Y | Validation performed and the payment method is valid. |
| INVALID | Y | Validation performed and the payment method is invalid. |
| NOT_SUPPORTED | Y | Our system cannot perform validation on this specific payment method. |
| ERROR | N | An error occurred while attempting the card validation |
Invalid reasons
Currently this section is only relevant for card validation and card marked as INVALID.
| Reason | Description |
|---|---|
| HARD_DECLINE | Validation failed because the card is flagged as lost or stolen |
| SOFT_DECLINE | Validation failed because it has been declined by the acquiring bank, mostly due to exceeding card limits or invalid card holder details. |
| INSUFFICIENT_FUNDS | We attempted to validate the card but the validation failed because of insufficient funds |
| SCHEME_NOT_SUPPORTED | Validation failed because the scheme is not supported |
| PREPAID_NOT_SUPPORTED | Validation failed because prepaid cards are not supported |
| BIN_NOT_SUPPORTED | Validation failed because the card’s bin is not supported |
Payment Method details
| Name | Type | Mandatory | Description |
|---|---|---|---|
| class | string | Y | The type of object which is being returned. In this case it will be payment_method_details. |
Method-specific parameters
Method: CREDITCARD
| Name | Type | Description |
|---|---|---|
| fingerprint | string | The credit card fingerprint Uuid. |
| holder | string | Cardholder name. |
| scheme | string | Credit card scheme. See the section below. |
| exp_month | string | Credit card expire month (ex: 01). |
| exp_year | string | Credit 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
| Name | Type | Description |
|---|---|---|
| fingerprint | string | The bank account fingerprint Uuid. |
| holder | string | The bank account holder name. |
| iban | string | The bank account IBAN code. |
| bic | string | The bank account BIC/SWIFT code. |
Method: ANCV_CVCO
| Name | Type | Description |
|---|---|---|
| cvco_reference | string | The reference of the transaction for the processor. |
| wallet | string | The 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"
}
}