logo
API docs by Redocly

ePayService Partners API (v2)

Introduction

Welcome to the ePayService Partners API! Here you will find all the information to get started with our API.

Hint: You can download this documentation in swagger.json format.

Authentication

To become authenticated you should first generate an API access token in your personal cabinet on the ePayService web site. You should also specify an IP address of the API caller.

API access settings

All API endpoints require authentication via Bearer token in Authorization header. Please, add Authorization: Bearer <insert-your-token-here> HTTP header to all your requests.

ACH Transfer

Create ACH transfer

Create ACH transfer.

Authorizations:
bearerAuth
Request Body schema: application/json
reference_id
required
string

An unique string identifying your transfer

account_number
required
string

Your ePayService wallet number to send money from

amount
required
string

A transfer amount

details
required
string

Details of the transfer (5-32 characters)

beneficiary_type
string or null

Beneficiary type: individual, legal

beneficiary_email
string or null

Beneficiary email

beneficiary_document_id
string or null

Beneficiary ID document number

beneficiary_name
required
string

Beneficiary name

beneficiary_phone
required
string or null

Beneficiary phone number

beneficiary_address
required
string or null

Beneficiary address

beneficiary_state
string or null

Beneficiary state (2-letter code)

beneficiary_city
required
string or null

Beneficiary city

beneficiary_zip_code
required
string or null

Beneficiary ZIP code

beneficiary_bank_name
required
string

Bank name

beneficiary_bank_account_number
required
string

Bank account number

beneficiary_bank_account_type
required
string

Bank account type: checking, savings

beneficiary_bank_aba_routing_number
required
string

Bank ABA number

beneficiary_bank_city
string

Bank city

beneficiary_bank_state
string

Bank state (2-letter code)

beneficiary_bank_zip_code
string

Bank ZIP code

Responses

Request samples

Content type
application/json
{
  • "reference_id": "ACH30099",
  • "account_number": "9011232398561234",
  • "amount": "34.55",
  • "details": "Pay invoice 123",
  • "beneficiary_type": "individual",
  • "beneficiary_email": "[email protected]",
  • "beneficiary_document_id": "P7771234567",
  • "beneficiary_name": "Alex Smith",
  • "beneficiary_phone": "15417543010",
  • "beneficiary_address": "Queen st. 34/1",
  • "beneficiary_state": "NY",
  • "beneficiary_city": "New York",
  • "beneficiary_zip_code": "10075",
  • "beneficiary_bank_name": "Bank of America",
  • "beneficiary_bank_account_number": "102911456",
  • "beneficiary_bank_account_type": "checking",
  • "beneficiary_bank_aba_routing_number": "456109678",
  • "beneficiary_bank_city": "New York",
  • "beneficiary_bank_state": "NY",
  • "beneficiary_bank_zip_code": "10256"
}

Response samples

Content type
application/json
{
  • "reference_id": "ACH30099",
  • "account_number": "9011232398561234",
  • "amount": "34.55",
  • "details": "Pay invoice 123",
  • "beneficiary_type": "individual",
  • "beneficiary_email": "[email protected]",
  • "beneficiary_document_id": "P7771234567",
  • "beneficiary_name": "Alex Smith",
  • "beneficiary_phone": "15417543010",
  • "beneficiary_address": "Queen st. 34/1",
  • "beneficiary_state": "NY",
  • "beneficiary_city": "New York",
  • "beneficiary_zip_code": "10075",
  • "beneficiary_bank_name": "Bank of America",
  • "beneficiary_bank_account_number": "102911456",
  • "beneficiary_bank_account_type": "checking",
  • "beneficiary_bank_aba_routing_number": "456109678",
  • "beneficiary_bank_city": "New York",
  • "beneficiary_bank_state": "NY",
  • "beneficiary_bank_zip_code": "10256",
  • "status_for_sender": "created"
}

Show ACH transfer

Show ACH transfer details.

Authorizations:
bearerAuth
path Parameters
reference_id
required
string

An unique string identifying your transfer

Responses

Response samples

Content type
application/json
{
  • "reference_id": "ACH30099",
  • "account_number": "9011232398561234",
  • "amount": "34.55",
  • "details": "Pay invoice 123",
  • "beneficiary_type": "individual",
  • "beneficiary_email": "[email protected]",
  • "beneficiary_document_id": "P7771234567",
  • "beneficiary_name": "Alex Smith",
  • "beneficiary_phone": "15417543010",
  • "beneficiary_address": "Queen st. 34/1",
  • "beneficiary_state": "NY",
  • "beneficiary_city": "New York",
  • "beneficiary_zip_code": "10075",
  • "beneficiary_bank_name": "Bank of America",
  • "beneficiary_bank_account_number": "102911456",
  • "beneficiary_bank_account_type": "checking",
  • "beneficiary_bank_aba_routing_number": "456109678",
  • "beneficiary_bank_city": "New York",
  • "beneficiary_bank_state": "NY",
  • "beneficiary_bank_zip_code": "10256",
  • "status_for_sender": "created"
}

Bulk create ACH transfers

Bulk create ACH transfers.

Authorizations:
bearerAuth
Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "bulk": [
    ]
}

Response samples

Content type
application/json
{
  • "bulk": [
    ]
}

Bulk show ACH transfers

Bulk show ACH transfer details.

Authorizations:
bearerAuth
Request Body schema: application/json
reference_ids
required
Array of strings

An array of identifiers of your transfers

Responses

Request samples

Content type
application/json
{
  • "reference_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "bulk": [
    ]
}

Check Transfer

Create check transfer

Create check transfer.

Authorizations:
bearerAuth
Request Body schema: application/json
reference_id
required
string

An unique string identifying your transfer

account_number
required
string

Your ePayService wallet number to send money from

amount
required
string

A transfer amount

details
required
string

Details of the transfer (5-32 characters)

beneficiary_type
string or null

Beneficiary type: individual, legal

beneficiary_email
string or null

Beneficiary email

beneficiary_document_id
string or null

Beneficiary ID document number

beneficiary_name
required
string

Beneficiary name (6-32 characters)

beneficiary_address
required
string

Beneficiary address (8-50 characters)

beneficiary_city
required
string or null

Beneficiary city (3-32 characters)

beneficiary_zip_code
required
string

Beneficiary ZIP code

beneficiary_state
required
string

Beneficiary state (2-letter code)

beneficiary_phone
string or null

Beneficiary phone number

Responses

Request samples

Content type
application/json
{
  • "reference_id": "CHECK39876",
  • "account_number": "9011232398561234",
  • "amount": "104.33",
  • "details": "Pay invoice #4",
  • "beneficiary_type": "individual",
  • "beneficiary_email": "[email protected]",
  • "beneficiary_document_id": "P7771234567",
  • "beneficiary_name": "Alex Smith",
  • "beneficiary_address": "St. Antonio st. 23/4",
  • "beneficiary_city": "New York",
  • "beneficiary_zip_code": "10075",
  • "beneficiary_state": "NY",
  • "beneficiary_phone": "15417543010"
}

Response samples

Content type
application/json
{
  • "reference_id": "CHECK39876",
  • "account_number": "9011232398561234",
  • "amount": "104.33",
  • "details": "Pay invoice #4",
  • "beneficiary_type": "individual",
  • "beneficiary_email": "[email protected]",
  • "beneficiary_document_id": "P7771234567",
  • "beneficiary_name": "Alex Smith",
  • "beneficiary_address": "St. Antonio st. 23/4",
  • "beneficiary_city": "New York",
  • "beneficiary_zip_code": "10075",
  • "beneficiary_state": "NY",
  • "beneficiary_phone": "15417543010",
  • "status_for_sender": "created"
}

Show check transfer

Show check transfer details.

Authorizations:
bearerAuth
path Parameters
reference_id
required
string

An unique string identifying your transfer

Responses

Response samples

Content type
application/json
{
  • "reference_id": "CHECK39876",
  • "account_number": "9011232398561234",
  • "amount": "104.33",
  • "details": "Pay invoice #4",
  • "beneficiary_type": "individual",
  • "beneficiary_email": "[email protected]",
  • "beneficiary_document_id": "P7771234567",
  • "beneficiary_name": "Alex Smith",
  • "beneficiary_address": "St. Antonio st. 23/4",
  • "beneficiary_city": "New York",
  • "beneficiary_zip_code": "10075",
  • "beneficiary_state": "NY",
  • "beneficiary_phone": "15417543010",
  • "status_for_sender": "created"
}

Bulk create check transfers

Bulk create check transfers.

Authorizations:
bearerAuth
Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "bulk": [
    ]
}

Response samples

Content type
application/json
{
  • "bulk": [
    ]
}

Bulk show check transfers

Bulk show check transfer details.

Authorizations:
bearerAuth
Request Body schema: application/json
reference_ids
required
Array of strings

An array of identifiers of your transfers

Responses

Request samples

Content type
application/json
{
  • "reference_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "bulk": [
    ]
}

Card Transfer

Create card transfer

Create card transfer.

There're 2 ways to specify transfer amount:

  • amount property in account's currency.
  • sent_amount property in sent_currency currency.

One of these properties is required for any transfer.

You can pass either of them and omit the other one.

Authorizations:
bearerAuth
Request Body schema: application/json
reference_id
required
string

Unique string identifying your transfer

account_number
required
string

Your ePayService wallet number to send money from

card_number
required
string

Card number (16 digits)

card_name
required
string

Cardholder name

comment
required
string

Commentary for the transfer (3-32 characters)

card_country_code
required
string

Card country code (ISO 3166-1, 2 characters)

sent_currency
required
string

Transfer will be sent to the third-party provider in this currency. Possible values must be obtained from /ext_cards/sent_currencies.

amount
string

Transfer amount in account's currency. This property could be ommited if sent_amount is present.

sent_amount
string

Transfer amount in sent_currency. This property could be ommited if amount is present.

Responses

Request samples

Content type
application/json
{
  • "reference_id": "ECARD1234",
  • "account_number": "9011232398561234",
  • "card_number": "5500000000000004",
  • "card_name": "JOHN SMITH",
  • "comment": "Pay for work",
  • "card_country_code": "UA",
  • "sent_currency": "USD",
  • "amount": "120.00",
  • "sent_amount": "7800"
}

Response samples

Content type
application/json
{
  • "reference_id": "ECARD1234",
  • "account_number": "9011232398561234",
  • "card_name": "JOHN SMITH",
  • "comment": "Pay for work",
  • "card_country_code": "UA",
  • "sent_currency": "USD",
  • "amount": "120.00",
  • "sent_amount": "7800",
  • "status_for_sender": "created",
  • "masked_card_number": "*** 5657",
  • "currency": "USD"
}

Show card transfer

Show card transfer details.

Authorizations:
bearerAuth
path Parameters
reference_id
required
string

Unique string identifying your transfer

Responses

Response samples

Content type
application/json
{
  • "reference_id": "ECARD1234",
  • "account_number": "9011232398561234",
  • "card_name": "JOHN SMITH",
  • "comment": "Pay for work",
  • "card_country_code": "UA",
  • "sent_currency": "USD",
  • "amount": "120.00",
  • "sent_amount": "7800",
  • "status_for_sender": "created",
  • "masked_card_number": "*** 5657",
  • "currency": "USD"
}

Bulk create card transfers

Bulk create card transfers.

There're 2 ways to specify transfer amount:

  • amount property in account's currency.
  • sent_amount property in sent_currency currency.

One of these properties is required for any transfer.

You can pass either of them and omit the other one.

Authorizations:
bearerAuth
Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "bulk": [
    ]
}

Response samples

Content type
application/json
{
  • "bulk": [
    ]
}

Bulk show card transfers

Bulk show card transfer details.

Authorizations:
bearerAuth
Request Body schema: application/json
reference_ids
required
Array of strings

Array of identifiers of your transfers

Responses

Request samples

Content type
application/json
{
  • "reference_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "bulk": [
    ]
}

Get list of sent currencies

Get list of possible currencies for sent_currency field.

Authorizations:
bearerAuth
query Parameters
card_country_code
required
string
Example: card_country_code=UA

Card country code

card_number
required
string
Example: card_number=5500000000000004

Full card number

Responses

Response samples

Content type
application/json
[
  • "USD"
]

P2P Transfer

Create P2P transfer

Create internal P2P transfer to other ePayService user wallet.

Authorizations:
bearerAuth
Request Body schema: application/json
reference_id
required
string

An unique string identifying your transfer

sender_account_number
required
string

Your wallet number

receiver_account_number
required
string

A receiver user wallet number

amount
required
number

A transfer amount

comment
required
string

A comment for the transfer (5-32 characters)

protection_code
string

A secret code the receiver user need to know to be able to accept this transfer

protection_days
integer

A number of days a protected transfer will be ready for the acceptance

Responses

Request samples

Content type
application/json
{
  • "reference_id": "ABC30099",
  • "sender_account_number": "9011232398561234",
  • "receiver_account_number": "1023345412127878",
  • "amount": 34.55,
  • "comment": "Pay invoice 123",
  • "protection_code": "SuperSecret123",
  • "protection_days": 7
}

Response samples

Content type
application/json
{
  • "reference_id": "ABC30099",
  • "status_for_sender": "created",
  • "sender_account_number": "9011232398561234",
  • "receiver_account_number": "1023345412127878",
  • "amount": "34.55",
  • "comment": "Pay invoice 123",
  • "is_protected": false
}

Show P2P transfer

Show P2P transfer details.

Authorizations:
bearerAuth
path Parameters
reference_id
required
string

An unique string identifying your transfer

Responses

Response samples

Content type
application/json
{
  • "reference_id": "ABC30099",
  • "status_for_sender": "created",
  • "sender_account_number": "9011232398561234",
  • "receiver_account_number": "1023345412127878",
  • "amount": "34.55",
  • "comment": "Pay invoice 123",
  • "is_protected": false
}

Bulk create P2P transfers

Bulk create P2P transfers to ePayService users.

Authorizations:
bearerAuth
Request Body schema: application/json
required
Array of objects (P2P details)

Responses

Request samples

Content type
application/json
{
  • "bulk": [
    ]
}

Response samples

Content type
application/json
{
  • "bulk": [
    ]
}

Bulk show P2P transfers

Bulk show P2P transfer details.

Authorizations:
bearerAuth
Request Body schema: application/json
reference_ids
required
Array of strings

An array of identifiers of your transfers

Responses

Request samples

Content type
application/json
{
  • "reference_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "bulk": [
    ]
}

Ping

Ping

Use this method for testing API availability. You can pass arbitrary parameters to this method, they all will be returned in a response.

Authorizations:
bearerAuth
Request Body schema: application/json
any_parameter
string

Arbitrary parameter

Responses

Request samples

Content type
application/json
{
  • "any_parameter": "Hello, world!"
}

Response samples

Content type
application/json
{
  • "any_parameter": "Hello, world!"
}

Users

List all your wallets

Get the list of all your wallets.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Check wallet owner

DEPRECATED! Use /users/check_wallet_owner_info instead! Use this method to test if specified wallet exist and belongs to specified users.

Authorizations:
bearerAuth
Request Body schema: application/json
Array of objects

Array of wallet and user data

Responses

Request samples

Content type
application/json
{
  • "wallets": [
    ]
}

Response samples

Content type
application/json
[
  • [
    ]
]

Check wallet owner/company (v2)

Use this method to check if specified wallet exists and belongs to specified user/company. This method accepts multiple checks in one request. For each check the field 'wallet_number' must always be provided. All other fields are optional but their presence will affect the result.

Authorizations:
bearerAuth
Request Body schema: application/json
Array of objects

An array of wallet and user/company data

Responses

Request samples

Content type
application/json
{
  • "wallets": [
    ]
}

Response samples

Content type
application/json
{
  • "wallets": [
    ]
}

Get wallet info

Use this method to get information about specified wallets.

Authorizations:
bearerAuth
Request Body schema: application/json
wallets
Array of strings

An array of wallets' numbers

Responses

Request samples

Content type
application/json
{
  • "wallets": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Wire Transfer

Create wire transfer

Create wire transfer.

Authorizations:
bearerAuth
Request Body schema: application/json
reference_id
required
string

An unique string identifying your transfer

account_number
required
string

Your ePayService wallet number to send money from

type
required
string

A wire transfer type:

  • wire - send wire to individual
  • wirejur - send wire to legal person
amount
required
string

A transfer amount

currency
required
string

A transfer currency

details
required
string

Details of the transfer (5-140 characters)

beneficiary_name
required
string

Beneficiary name

beneficiary_phone
required
string

Beneficiary phone number

beneficiary_address
required
string

Beneficiary address

beneficiary_city
required
string

Beneficiary city

beneficiary_zip_code
required
string

Beneficiary ZIP code

beneficiary_country
required
string

Beneficiary country name (ISO)

beneficiary_state
string or null

Beneficiary country state name (ISO). Required for United States

beneficiary_bank_account_number
required
string

Bank account number

beneficiary_bank_name
required
string

Bank name

beneficiary_bank_country
required
string

Bank country name (ISO)

beneficiary_bank_address
required
string

Bank address

beneficiary_bank_zip_code
required
string

Beneficiary bank ZIP code

beneficiary_bank_swift
string or null

Bank SWIFT code

correspondent_bank_name
string or null

Correspondent bank name

correspondent_bank_swift
string or null

Correspondent bank SWIFT code

correspondent_bank_address
string or null

Correspondent bank address

correspondent_bank_zip_code
string or null

Correspondent bank ZIP code

Responses

Request samples

Content type
application/json
{
  • "reference_id": "WIRE457890",
  • "account_number": "9011232398561234",
  • "type": "wire",
  • "amount": "34.55",
  • "currency": "EUR",
  • "details": "Pay invoice 123",
  • "beneficiary_name": "Alex Smith",
  • "beneficiary_phone": "14561029675",
  • "beneficiary_address": "Queen st. 34/1",
  • "beneficiary_city": "London",
  • "beneficiary_zip_code": "45688",
  • "beneficiary_country": "United Kingdom",
  • "beneficiary_state": "NY",
  • "beneficiary_bank_account_number": "102911456",
  • "beneficiary_bank_name": "Bank of America",
  • "beneficiary_bank_country": "United States",
  • "beneficiary_bank_address": "New York, 45th Street 67/8",
  • "beneficiary_bank_zip_code": "45688",
  • "beneficiary_bank_swift": "BOFAUS3N",
  • "correspondent_bank_name": "Citibank Colombia",
  • "correspondent_bank_swift": "CITICOBB",
  • "correspondent_bank_address": "Calle Maria 63",
  • "correspondent_bank_zip_code": "45688"
}

Response samples

Content type
application/json
{
  • "reference_id": "WIRE457890",
  • "account_number": "9011232398561234",
  • "type": "wire",
  • "amount": "34.55",
  • "currency": "EUR",
  • "details": "Pay invoice 123",
  • "beneficiary_name": "Alex Smith",
  • "beneficiary_phone": "14561029675",
  • "beneficiary_address": "Queen st. 34/1",
  • "beneficiary_city": "London",
  • "beneficiary_zip_code": "45688",
  • "beneficiary_country": "United Kingdom",
  • "beneficiary_state": "NY",
  • "beneficiary_bank_account_number": "102911456",
  • "beneficiary_bank_name": "Bank of America",
  • "beneficiary_bank_country": "United States",
  • "beneficiary_bank_address": "New York, 45th Street 67/8",
  • "beneficiary_bank_zip_code": "45688",
  • "beneficiary_bank_swift": "BOFAUS3N",
  • "correspondent_bank_name": "Citibank Colombia",
  • "correspondent_bank_swift": "CITICOBB",
  • "correspondent_bank_address": "Calle Maria 63",
  • "correspondent_bank_zip_code": "45688",
  • "status_for_sender": "created"
}

Show wire transfer

Show wire transfer details.

Authorizations:
bearerAuth
path Parameters
reference_id
required
string

An unique string identifying your transfer

Responses

Response samples

Content type
application/json
{
  • "reference_id": "WIRE457890",
  • "account_number": "9011232398561234",
  • "type": "wire",
  • "amount": "34.55",
  • "currency": "EUR",
  • "details": "Pay invoice 123",
  • "beneficiary_name": "Alex Smith",
  • "beneficiary_phone": "14561029675",
  • "beneficiary_address": "Queen st. 34/1",
  • "beneficiary_city": "London",
  • "beneficiary_zip_code": "45688",
  • "beneficiary_country": "United Kingdom",
  • "beneficiary_state": "NY",
  • "beneficiary_bank_account_number": "102911456",
  • "beneficiary_bank_name": "Bank of America",
  • "beneficiary_bank_country": "United States",
  • "beneficiary_bank_address": "New York, 45th Street 67/8",
  • "beneficiary_bank_zip_code": "45688",
  • "beneficiary_bank_swift": "BOFAUS3N",
  • "correspondent_bank_name": "Citibank Colombia",
  • "correspondent_bank_swift": "CITICOBB",
  • "correspondent_bank_address": "Calle Maria 63",
  • "correspondent_bank_zip_code": "45688",
  • "status_for_sender": "created"
}

Bulk create wire transfers

Bulk create wire transfers.

Authorizations:
bearerAuth
Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "bulk": [
    ]
}

Response samples

Content type
application/json
{
  • "bulk": [
    ]
}

Bulk show wire transfers

Bulk show wire transfer details.

Authorizations:
bearerAuth
Request Body schema: application/json
reference_ids
required
Array of strings

An array of identifiers of your transfers

Responses

Request samples

Content type
application/json
{
  • "reference_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "bulk": [
    ]
}

WebMoney Transfer

Create WebMoney transfer

Create WebMoney transfer.

Authorizations:
bearerAuth
Request Body schema: application/json
reference_id
required
string

An unique string identifying your transfer

account_number
required
string

Your ePayService wallet number to send money from

wm_number
required
string

WebMoney wallet number

amount
required
string

A transfer amount

details
required
string

Details of the transfer (5-32 characters)

protection_code
string

A secret code the receiver need to know to be able to accept this transfer (minimum 5 characters)

protection_days
integer

A number of days a protected transfer will be ready for the acceptance (1-120)

Responses

Request samples

Content type
application/json
{
  • "reference_id": "WM29764",
  • "account_number": "9011232398561234",
  • "wm_number": "Z656413287879",
  • "amount": "34.55",
  • "details": "Pay for work",
  • "protection_code": "SuperSecret123",
  • "protection_days": 7
}

Response samples

Content type
application/json
{
  • "reference_id": "WM29764",
  • "account_number": "9011232398561234",
  • "wm_number": "Z656413287879",
  • "amount": "34.55",
  • "details": "Pay for work",
  • "status_for_sender": "created",
  • "is_protected": true
}

Show WebMoney transfer

Show WebMoney transfer details.

Authorizations:
bearerAuth
path Parameters
reference_id
required
string

An unique string identifying your transfer

Responses

Response samples

Content type
application/json
{
  • "reference_id": "WM29764",
  • "account_number": "9011232398561234",
  • "wm_number": "Z656413287879",
  • "amount": "34.55",
  • "details": "Pay for work",
  • "status_for_sender": "created",
  • "is_protected": true
}

Bulk create WebMoney transfers

Bulk create WebMoney transfers.

Authorizations:
bearerAuth
Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "bulk": [
    ]
}

Response samples

Content type
application/json
{
  • "bulk": [
    ]
}

Bulk show WebMoney transfers

Bulk show WebMoney transfer details.

Authorizations:
bearerAuth
Request Body schema: application/json
reference_ids
required
Array of strings

An array of identifiers of your transfers

Responses

Request samples

Content type
application/json
{
  • "reference_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "bulk": [
    ]
}