Payall (1.0)

Introduction

The Payall APIs are designed to enable clients to make and receive payments globally by quickly and easily integrating into their native systems without knowing how arcane payment systems work globally or even having many details about the recipient. We’ve integrated a combination of more common methods, new services as well novel techniques pioneered by the company representing the most diverse and ever expanding final-mile payment options possible. This enables the client to make an instant payment to anyone, anywhere and enables the recipient to decide the best way to access their money. (The above is subject to sanctions and regulated entity approvals).

Authenticate

To make API calls, include the bearer token in the Authorization header with the Bearer authentication scheme.

The value is Bearer <Your-Secret-Key>.

The URL to the API service is either:

Errors

APIs use the Status-Line part of an HTTP response message to inform clients of their request’s overarching result.

HTTP defines over 40 standard status codes that can be used to convey the results of a client’s request. The status codes are divided into the five categories presented here:

  • 1xx: Informational - Communicates transfer protocol-level information
  • 2xx: Success - Indicates that the client’s request was accepted successfully.
  • 3xx: Redirection - Indicates that the client must take some additional action in order to complete their request.
  • 4xx: Client Error - This category of error status codes points the finger at clients.
  • 5xx: Server Error - The server takes responsibility for these error status codes.
Error Code Error Description
UNAUTHORIZED Missing or invalid API Key provided.
REQUEST_INVALID The request provided is invalid. Please check details field for more details.
BALANCE_INSUFFICIENT The operation could not be completed because the associated account does not have a sufficient balance available.

Country Specifications

Country Specifications

Retrieve country specifications

This endpoint is used to retrieve a country specifications based on country code

Request Body schema: application/json
program_id
required
string

ID of the program provided by Payall

country_code
required
string

Two-letter country code (ISO 3166-1 alpha-2)

Responses

200

OK

400

Bad Request

500

Internal Server Error

post /country_specifications/get
https://api.payall.com/v1/country_specifications/get
https://api.sandbox.payall.com/v1/country_specifications/get

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "program_id": "string",
  • "country_code": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "data":
    {
    }
}

Account Holders

Account Holders

Create account holder

This endpoint is used to create an account holder

Request Body schema: application/json
program_id
required
string

ID of the program provided by Payall

country_code
required
string

The country in which the account holder resides. Two-letter country code (ISO 3166-1 alpha-2)

legal_entity_type
required
string
Value: "INDIVIDUAL"
first_name
required
string [ 1 .. 50 ] characters
last_name
required
string [ 1 .. 50 ] characters
birth_date
string <date>

Date of birth, in RFC-3339 format

phone
string

The phone number, in E.123 format

email
string

The email address

nationality
string

The nationality

billing
object

Billing

occupation
Array of strings

List of occupation

source_of_funds
Array of strings

List of source of funds

national_identity
object

National identity

documents
object

List of documents

asset_wallet
object

Asset wallet

tos_acceptance
object

Terms of service acceptance

Responses

200

OK

post /account_holders/create
https://api.payall.com/v1/account_holders/create
https://api.sandbox.payall.com/v1/account_holders/create

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "program_id": "string",
  • "country_code": "string",
  • "legal_entity_type": "INDIVIDUAL",
  • "first_name": "string",
  • "last_name": "string",
  • "birth_date": "2020-08-21",
  • "phone": "string",
  • "email": "string",
  • "nationality": "string",
  • "billing":
    {
    },
  • "occupation":
    [
    ],
  • "source_of_funds":
    [
    ],
  • "national_identity":
    {
    },
  • "documents":
    {
    },
  • "asset_wallet":
    {
    },
  • "tos_acceptance":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "country_code": "string",
  • "legal_entity_type": "INDIVIDUAL",
  • "first_name": "string",
  • "last_name": "string",
  • "birth_date": "2020-08-21",
  • "phone": "string",
  • "email": "string",
  • "billing":
    {
    },
  • "occupation":
    [
    ],
  • "source_of_funds":
    [
    ],
  • "national_identity":
    {
    },
  • "documents":
    {
    },
  • "asset_wallet":
    {
    },
  • "tos_acceptance":
    {
    },
  • "verification":
    {
    }
}

Retrieve account holder

This endpoint is used to retrieve an account holder

Request Body schema: application/json
id
required
string

ID of the object

Responses

200

OK

post /account_holders/get
https://api.payall.com/v1/account_holders/get
https://api.sandbox.payall.com/v1/account_holders/get

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "country_code": "string",
  • "legal_entity_type": "INDIVIDUAL",
  • "first_name": "string",
  • "last_name": "string",
  • "birth_date": "2020-08-21",
  • "phone": "string",
  • "email": "string",
  • "billing":
    {
    },
  • "occupation":
    [
    ],
  • "source_of_funds":
    [
    ],
  • "national_identity":
    {
    },
  • "documents":
    {
    },
  • "asset_wallet":
    {
    },
  • "tos_acceptance":
    {
    },
  • "verification":
    {
    }
}

Update account holder

This endpoint is used to update an account holder

Request Body schema: application/json
id
required
string
first_name
required
string [ 1 .. 50 ] characters
last_name
required
string [ 1 .. 50 ] characters
birth_date
string <date>

Date of birth, in RFC-3339 format

phone
string

The phone number, in E.123 format

email
string

The email address

billing
object

Billing

occupation
Array of strings

List of occupation

source_of_funds
Array of strings

List of occupation

national_identity
object

National ID

documents
object

List of documents

asset_wallet
object

Asset wallet

tos_acceptance
object

Terms of service acceptance

Responses

200

OK

post /account_holders/update
https://api.payall.com/v1/account_holders/update
https://api.sandbox.payall.com/v1/account_holders/update

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "birth_date": "2020-08-21",
  • "phone": "string",
  • "email": "string",
  • "billing":
    {
    },
  • "occupation":
    [
    ],
  • "source_of_funds":
    [
    ],
  • "national_identity":
    {
    },
  • "documents":
    {