Api Access List

Access List

An access list is used in conjunction with a payment channel to allow only whitelisted users to perform transactions.

This can be achieved by enabling Access List within the desired Payment Channel.

Configuration

Payments Channels which will be using access list need to have “Access List Enabled” toggle switched on

To enable this feature, follow the below steps:

Log into your Portal
Go to CRM > Customers
Choose the customer
Go to Related > Payment Channels
Choose the payment channel and click on the Edit button on the right
Switch on the “Access List Enabled” toggle and click “Save”

Create an Item

Access List can only be used using live credentials

POST https://api.quaife.net/v1/accesslist/emails

{
“emailHash”: “332b3278c9608e01d390c58ccd4e8f735e4e7a298bdacd59074b575c35c6cd6c”
}

For example, Merchant has following parameters:

API key: live_493gfg37gf97g34f7g
Customer email: john@doe.com

Then Merchant will need to calculate SHA-256 signature of the following string:

john@doe.comlive_493gfg37gf97g34f7g

That will result in the following:

332b3278c9608e01d390c58ccd4e8f735e4e7a298bdacd59074b575c35c6cd6c

Response:

{
“id”: “blo_530dc520f47045f0a8”, “status”: “Created”
}

Deleting an item

POST https://api.quaife.net/v1/accesslist/emails/332b3278c9608e01d390c58ccd4e8f735e4e7a298bdacd59074b57
5c35c6cd6c

For example, Merchant has following parameters:

API key: live_493gfg37gf97g34f7g Customer email: john@doe.com

Then Merchant will need to calculate SHA-256 signature of the following string:

john@doe.comlive_493gfg37gf97g34f7g

That will result in the following:

332b3278c9608e01d390c58ccd4e8f735e4e7a298bdacd59074b575c35c6cd6c

Response:

{
“id”: “”,
“status”: “Deleted”
}

Errors when creating Access List

Duplicate Email

400 Bad Request

{
“errors”: [
{
“type”: “paymentError”,
“code”: “accessListDuplicateEntry”,
“message”: “This email it’s duplicate. Please use some other email to create an access list item.”
}
]
}

Using Test Credentials

400 Bad Request

{
“errors”: [
{
“type”: “paymentError”,
“code”: “accessListNeedLiveCredential”,
“message”: “You need live credential to create Access List”
}
]
}

Inserting Wrong Hashed Value

{
“errors”: [
{
“errorType”: “invalidRequest”,
“code”: “validationError”,
“parameter”: “emailHash”,
“message”: “The length of ’email Hash’ must be at least 64 characters. You entered 63 characters.”
}
]
}

Errors when deleting Access List

Email not found

400 Bad Request

{
“errors”: [
{
“type”: “paymentError”,
“code”: “accessListIsNotFound”,
“message”: “This email it’s not found in our Access list”
}
]
}

Other Errors

When “Access List Enabled” toggle is enabled and email is not in the Access list, the following response is displayed when trying to create a transaction:

{
“errors”: [
{
“type”: “paymentError”,
“code”: “notInTheAccessList”,
“message”: “The email is not on the access list”
}
]
}

Access List

Configuration

Create an Item

Deleting an item

Errors when creating Access List

Errors when deleting Access List

Other Errors

MERCHANT

SIGN UP