Create a zero-value VERIFY order to check a card without charging the customer.
A zero-value account verification is an order with the action VERIFY and an amount of 0. The customer enters their card information through one of the supported integration methods, and the card issuer to approve a payment of zero, and nothing is charged. For when to use it, see Zero-value account verification.
Create the order
HTTP method: POST
Resource (URI): https://api-gateway.sandbox.ngenius-payments.com/transactions/outlets/{outletRef}/orders
| Header | Value |
|---|---|
| Authorization | Bearer access_token |
| Content-Type | application/vnd.ni-payment.v2+json |
| Accept | application/vnd.ni-payment.v2+json |
| Attribute | Required | Description |
|---|---|---|
action | Yes | VERIFY |
amount.currencyCode | Yes | For example AED |
amount.value | Yes | 0 |
emailAddress | Yes | The customer's email address |
merchantAttributes.redirectUrl | No | Where the customer goes after the verification |
merchantAttributes.skip3DS | No | true to skip 3-D Secure |
For the other attributes an order can take, see List of order input attributes.
{
"action": "VERIFY",
"amount": { "currencyCode": "AED", "value": 0 },
"emailAddress": "[email protected]",
"merchantAttributes": {
"redirectUrl": "https://example.com/card-checked"
}
}On the hosted payment page
Redirect the customer to _links.payment.href in the response, as for any hosted payment page order. The customer enters their card details, and the page runs 3-D Secure unless you skipped it. The customer then returns to your redirectUrl, with the order reference in the ref query parameter.
Check the result
Retrieve the order and check the payment state in _embedded.payment[0].state.
state | Meaning |
|---|---|
VERIFIED | The verification passed. The card is valid. |
FAILED | The verification failed, for example because the customer did not complete 3-D Secure. Do not save the card. |
Retrieve the order rather than wait for a webhook: the webhook events do not include one for verifications.
Save the card
If your account has Pay by Token, the payment includes a savedCard block, as it does whenever a card is presented. Store it to use the card later. See Pay by Token.
Cards
Visa, Mastercard and American Express.
Verifying with card details from your server
The Verify card request checks a card from the card number, expiry date and security code your server sends, without the payment page. Sending card details from your server requires PCI DSS compliance.