Introduction

Description

Merchant API provides access for third-parties to standard functions and services implemented at Paytriot.

Developers can build their own custom applications, tools, and services to support their programs or components of their programs.

Security

• The following aspects create additional security for each third-party.
• Both login and password are required for each call to the API in order to authenticate the third-party.
• The password is unique per each third-party.
• HTTPS Security is mandatory – an SSL certificate is required.
• All sensitive data is transmitted in an encrypted format under a 3-DES key.

Version

To see the current version and details of recent changes, please refer to Changelog.

Actions

Note: All request fields must be sent as a string despite the field type differences, as fields are parsed to proper types.

Account

Change address

Change account address.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/update_account_address

Request

Parameter	M	Type	Length	Description
account	Y	N	20	Account ID.
country_code	N	A	3	ISO 3166-1
address_line1	N	AN	100
address_line2	N	AN	100
city	N	A	45
state	N	AN	40
postal_code	N	AN	10
billing_country_code	N	A	3	ISO 3166-1
billing_address_line1	Y	AN	100
billing_address_line2	N	AN	100
billing_city	N	A	45
billing_state	N	AN	40
billing_postal_code	N	AN	10
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "account": 1753154,  
   "country_code": "GBR",  
   "address_line1": "Bridge St",  
   "address_line2": "",  
   "city": "London",  
   "state": "",  
   "postal_code": "",  
   "billing_country_code": "",  
   "billing_address_line1": "",  
   "billing_address_line2": "",  
   "billing_city": "",  
   "billing_state": "",  
   "billing_postal_code": "",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.

{
   "status": "success",  
   "msg": "Address updated"
}

Change owner

Change account owner.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/update_account_owner

Request

Parameter	M	Type	Length	Description
account	Y	N	20	Account ID.
username	Y	AN	100
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "account": 1753154,  
   "username": "john.doe",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.

{
   "status": "success",  
   "msg": "Account owner updated"
}

Create

Create additional account to user. User must be approved first.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/create_account

Request

Parameter	M	Type	Length	Description
username	Y	AN	100
currency	Y	A	3	ISO 4217
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "username": "john.doe",  
   "currency": "GBP",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
account_id	Y	N	20	Account ID.
msg	Y	AN	255	See Message code.

{
   "status": "success",  
   "account_id": "1753154",  
   "msg": "Account successfully created."
}

Get card list

Get all account cards.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_account_cards

Request

Parameter	M	Type	Length	Description
account	Y	N	20	Account ID.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "account": "1753154",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
cards	Y	LIST
id	Y	N	20
balance	N	N	10,2
status	Y	A	1	Possible values: A: activated, N: not activated, B: blocked, S: suspended, T: admin suspend (temporary blocked), E: expired.
currency	Y	A	3	ISO 4217

{
   "status": "success",  
   "msg": "Success",  
   "cards":[    
      {    
         "id": "20",  
         "balance": "0.00",  
         "status": "N",  
         "currency": "USD"  
      }  
   ]
}

Get details

Get account detail by account ID.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_account_details

Request

Parameter	M	Type	Length	Description
account	Y	N	20	Account ID.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "account": "1753154",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
account_details	Y
account_number	N	N	20	Bank account address - account number.
currency	N	A	3	ISO 4217
account_program_group	N	AN	100
account_owner	N	AN	200
account_type	N	AN	100	Business/personal.
register_date	N	AN	10	ISO 8601
timezone	N	AN	100
account_address	N	AN	100
account_address_2	N	AN	100
account_city	N	AN	100
account_state	N	AN	100
account_postal_code	N	AN	100
account_country	N	AN	100
account_home_phone	N	AN	100
account_work_phone	N	AN	100
account_cell_phone	N	AN	100
account_billing_address	N	AN	100
account_billing_address_2	N	AN	100
account_billing_city	N	AN	100
account_billing_state	N	AN	100
account_billing_postal_code	N	AN	100
account_billing_country	N	AN	100

{
   "status": "success",  
   "msg": "Success",  
   "account_details":{    
      "account_number": "78726600",  
      "currency": "USD",  
      "account_program_group": "Group name",  
      "account_owner": "John Doe",  
      "account_type": "business",  
      "register_date": "2015-04-01",  
      "timezone": "Europe/London",  
      "account_address": "",  
      "account_address_2": "",  
      "account_city": "",  
      "account_state": "",  
      "account_postal_code": "",  
      "account_country": "United Kingdom",  
      "account_home_phone": "",  
      "account_work_phone": "",  
      "account_cell_phone": "",  
      "account_billing_address": "",  
      "account_billing_address_2": "",  
      "account_billing_city": "",  
      "account_billing_state": "",  
      "account_billing_postal_code": "",  
      "account_billing_country": "United Kingdom"  
   }
}

Get inventory

Get a list of envelope numbers and card ID numbers.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_account_inventory

Request

Parameter	M	Type	Length	Description
account	Y	N	20	Account ID.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "account": "1753154",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/ error.
msg	Y	AN	255	See Message code.
account	Y	N	20	Account ID.
inventory	Y	AN		Result is env1,cid1\|env2,cid2\|etc….

{
   "status": "success",  
   "msg": "Success",  
   "account": "1753154",  
   "inventory": "742652000000,15|742652000001,16|742652000002,17"
}

Get status

Get account status.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_account_status

Request

Parameter	M	Type	Length	Description
account	Y	N	20	Account ID.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "account": "1753154",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/ error.
msg	Y	AN	255	See Message code.
account	Y
id	Y	N	20	Account ID.
balance	N	N	10,2
currency	Y	A	3	ISO 4217
status_code	Y	N	2	See Account status*.
status	Y	A	10

*Note: Possible values: 1: normal, 3: receive funds only, 4: send funds only, 17: suspended by admin.

{
   "status": "success",  
   "msg": "Success",  
   "account":[    
      {    
         "id": "1753154",  
         "balance": "0.00",  
         "currency": "USD",  
         "status_code": "1",  
         "status": "Normal"  
      }  
   ]
}

Bank account

Add

Add external bank account.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/add_bank_account

Request

Parameter	M	Type	Length	Description
full_name_on_bank_account	Y	AN	255
bank_name	Y	AN	100	Bank account address - Bank name.
bank_address	Y	AN	100	Bank account address - Bank address.
bank_iban	C	AN	40	Bank account address - IBAN number. Mandatory if bank_account_number is not provided.
bank_swift	Y	AN	11	Bank account address - SWIFT code.
bank_city	Y	AN	100
bank_country_code	Y	A	2
bank_contact_phone	N	AN	100
branch_code	N	AN	100
bank_state	N	AN	100
corresponding_bank_swift	N	AN	11
corresponding_bank_name	N	AN	100
corresponding_bank_city	N	AN	100
corresponding_bank_currency_code	N	A	3	ISO 4217
primary	N	A	1	Set new bank account to be primary. Possible values: 1 - yes, 0 - no.
bank_account_number	C	AN	40	Bank account address - Account number. Mandatory if bank_account is not provided.
bank_sort_code	N	AN	6	Bank account address - Sort code.
bank_routing_number	N	AN	35	Bank account address - Routing number.
bank_financial_system_code	N	AN	11	Bank account address - Financial system code.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "full_name_on_bank_account": "John Doe",  
   "bank_name": "Bank name",  
   "bank_address": "Street name 1",
   "bank_iban": "GB8888888888888",
   "bank_swift": "654321",  
   "bank_city": "London",  
   "bank_country_code": "GBR",  
   "bank_contact_phone": "37012312345",  
   "branch_code": "73195",  
   "bank_state": "",  
   "corresponding_bank_swift": "",
   "corresponding_bank_name": "",
   "corresponding_bank_city": "",
   "corresponding_bank_currency_code": "_ISO_4217_",
   "primary": "1",
   "bank_account_number": "",
   "bank_sort_code": "",
   "bank_routing_number": "",
   "bank_financial_system_code": "SBIN0005943",
   "key": "_MERCHANT_KEY_",
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/ error.
msg	Y	AN	255	See Message code.
description	N	AN
bank_accounts_id	Y	N	20

{
   "status": "success",  
   "msg": "Bank account added",  
   "bank_accounts_id": "9625"
}

Get list

Get all user external bank accounts.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_user_bank_accounts

Request

Parameter	M	Type	Length	Description
username	Y	AN	100
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "username": "timer",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/ error.
msg	Y	AN	255	See Message code.
accounts	Y	LIST
id	Y	LIST
id	Y	N	20	Account ID.
account_number	Y	N	20	Bank account address - Account number.
status	Y	A	1	A: activated, N: not activated.
bank	Y	A	255	Bank account address - Bank name.
country	Y	A	5
swift	Y	A	11	Bank account address - SWIFT code.

{
   "status": "success",  
   "msg": "Success",  
   "accounts":{    
      "1753154":{    
         "id": "1753154",  
         "account_number": "78726600",  
         "status": "A",  
         "bank": "Bank Name",  
         "country": "LT",  
         "swift": "654321"  
      }  
   }
}

Card

Activate

Activate card by ID.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/activate_card

Request

Parameter	M	Type	Length	Description
card_id	Y	AN	20
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "card_id": 22,  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.

{
   "status": "Card successfully activated",  
   "msg": "Success"
}

Assign to account

Can assign card without movements from own account to other own or user’s account.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/assign_card_to_account

Request

Parameter	M	Type	Length	Description
inventoryaccount	Y	N	20	From account ID.
card_id	Y	N	20	Card ID.
account	Y	N	20	To account ID.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "inventoryaccount": "1753154",  
   "card_id": "1",  
   "account": "1753242",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.

{
   "status": "success",  
   "msg": "Card assigned to account"
}

Check ID info

Check card information by ID.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/check_cardid_info

Request

Parameter	M	Type	Length	Description
card_id	Y	AN	20	Card ID.
cardnumber	Y	N	16	Full card number, must be encrypted by 3DES algorithm with 3DES key – provided by Paytriot.
cvv	Y	N	3	CVV number, must be encrypted by 3DES algorithm with 3DES key – provided by Paytriot.
nameoncard	Y	AN	30
expirymonth	Y	N	2
expiryyear	Y	N	4
firstname	Y	A	60
lastname	Y	A	60
email	Y	A	50
mobile	Y	AN	20
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "card_id": "1353",  
   "cardnumber": "+auQjcJ8sh6xiArXQpsyYA==",  
   "cvv": "qcsc0SC\\/V\\/A=",  
   "nameoncard": "John Doe",  
   "expirymonth": "12",  
   "expiryyear": "15",  
   "firstname": "John",  
   "lastname": "Doe",  
   "email": "john.doe@test.loc",  
   "mobile": "38741220012",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
data
cardnumber	Y	A	5	If data match : ok, if does not match : notok.
cvv	Y	A	5	If data match : ok, if does not match : notok.
nameoncard	Y	A	5	If data match : ok, if does not match : notok.
expirymonth	Y	A	5	If data match : ok, if does not match : notok.
expiryyear	Y	A	5	If data match : ok, if does not match : notok.
firstname	Y	A	5	If data match : ok, if does not match : notok.
lastname	Y	A	5	If data match : ok, if does not match : notok.
email	Y	A	5	If data match : ok, if does not match : notok.
mobile	Y	A	5	If data match : ok, if does not match : notok.

{
   "status": "success",  
   "data":{    
      "cardnumber": "ok",  
      "cvv": "ok",  
      "nameoncard": "notok",  
      "expirymonth": "notok",  
      "expiryyear": "notok",  
      "firstname": "notok",  
      "lastname": "notok",  
      "email": "notok",  
      "mobile": "notok"  
   }
}

Create

Create card to account. In order to see if your card order was approved please use a function GetUserCards.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/create_card

Request

Parameter	M	Type	Length	Description
username	N	AN	100	Deprecated parameter.
accounts	Y	N	20	Account ID.
card_type	Y	N	20	ID must be get using call Get program.
country	Y	A	3	ISO 3166-1
nationality	N	A	3	Deprecated parameter.
first_name	N	A	50	Deprecated parameter.
middle_name	N	A	50	Deprecated parameter.
last_name	N	A	50	Deprecated parameter.
embossed_name	Y	A	100	Length and validation pattern depends on provider. Name to be printed on the plastic card including space (“ “) as a separator. Example: JOHN DOE.
family_status	N	A	1	Deprecated parameter.
gender	N	A	1	Deprecated parameter.
title	N	A	4	Deprecated parameter.
dob	N	AN	10	Deprecated parameter.
email	N	AN	50	Deprecated parameter.
phone	N	AN	16	Deprecated parameter.
address1	Y	AN	30
address2	N	AN	30
city	Y	AN	50
state	N	AN	50
post_code	Y	AN	9
is_virtual	Y	A	1	Possible values: Y: yes N: no.
shipping_method_id	N	N	20	Required field for physical card. ID must be get using call Get shipping method.
language	N	A	3	Deprecated parameter.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "username": "john.doe",  
   "accounts": "1753154,1753242",  
   "card_type": "15163652121588",  
   "country": "GBR",  
   "nationality": "GBR",  
   "first_name": "John",  
   "middle_name": "",  
   "last_name": "Doe",  
   "embossed_name": "JOHN DOE",  
   "family_status": "M",  
   "gender": "M",  
   "title": "Mr",  
   "dob": "1981-11-28",  
   "email": "john.doe@test.com",  
   "phone": "4432611151",
   "phone2": "",  
   "address1": "Super str 115",  
   "address2": "",  
   "city": "London",  
   "state": "",  
   "post_code": "15452",  
   "is_virtual": "Y",  
   "language": "ENG",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255

{
   "status": "success",  
   "msg": "You have successfully ordered a new card. Your request is under administration review now."
}

Get CVV

Get card CVV by card ID.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_card_cvv

Request

Parameter	M	Type	Length	Description
card_id	Y	AN	20
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "card_id": 22,  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
card_cvv	Y	AN		Encrypted card CVV. See Cryptography.

{
   "status": "success",  
   "msg": "Success",
   "card_cvv": "2pulYPkKkjY="
}

Get details

Get card details by card ID.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_card_details

Request

Parameter	M	Type	Length	Description
card_id	Y	AN	20
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "card_id": 22,  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/ error.
msg	Y	AN	255	See Message code.
card_details	Y
client_id	Y	N	20
card number	Y	AN		Encrypted card number. See Cryptography.
date_expired	Y	AN		Encrypted expiration date.* See Cryptography.
date_created	Y	AN	10	ISO 8601
name_on_card	Y	AN
card_type	Y	AN		virtual/ physical.

*Note. Encrypted expiration date format is set to be mm/yy. Here mm stands for the month (meaning the end of the selected month); yy stands for the last two digits of the year.

{
   "status": "success",  
   "msg": "Success",
   "card_details": {
      "client_id": "8181581815",
      "card_number": "PlKaAjbbDYfuBkH7P7WCnVRL3pEkqC5C",
      "date_expired": "12/20",
      "date_created": "2015-05-26",
      "name_on_card": "John Doe",
      "card_type": "physical"
   }
}

Get PIN

Get card PIN by card ID.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_card_pin

Request

Parameter	M	Type	Length	Description
card_id	Y	AN	20
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "card_id": 22,  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
card_pin	Y	AN		Encrypted card PIN. See Cryptography.

{
   "status": "success",  
   "msg": "Success",
   "card_pin": "0widB10vG/Y="
}

Get program

Get card programs to account.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_card_programs

Request

Parameter	M	Type	Length	Description
account_id	Y	N	20	Account ID.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "account_id": "1753154",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	Success/error.
	N	LIST
card_type	N	N	20
title	N	AN	100
is_virtual	N	N	1	Possible values: 1: yes, 0: no.
currency_id	N	N	11	Internal Paytriot currency ID.

{  
   "status": "success",  
   "0":{  
      "card_type": "15163652121588",  
      "title": "Corporate Card",  
      "is_virtual": "1",  
      "currency_id": "43"
   },  
   "1":{  
      "card_type": "15163652492401",  
      "title": "Corporate Card",  
      "is_virtual": "0",  
      "currency_id": "43"
   }
}

Get shipping method

Get list of all available shipping methods for country.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_shipping_methods

Request

Parameter	M	Type	Length	Description
country_code	Y	A	3	ISO 3166-1
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "country_code": "GBR",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
shipping_methods	Y	LIST
id	Y	N	20
name	Y	AN	100

{
   "status": "success",  
   "msg": "Success",  
   "shipping_methods":[    
      {    
         "id": "1",  
         "name": "Standard"  
      }  
   ]
}

Get ACS password

Get card ACS password by card ID.

URL	Method
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_card_acs_password	POST

Request

Parameter	M	Type	Length	Description
card_id	Y	N	20	Card ID.
key	Y	AN	16	Merchant API Key – provided by \nandName%.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
  "card_id": 22, 
  "key": "_MERCHANT_KEY_", 
  "ts": "_TIMESTAMP_", 
  "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
acs_password	Y	AN	255	Must be encrypted by 3DES algorithm with 3DES key – provided by Paytriot.

{
  "status": "success", 
  "acs_password": "7H+Ft5z1Zq6\/uX52u2254A=="
}

Change ACS password

Change card ACS password by card ID.

URL	Method
https://api.paytriot.co.uk/api/merchant/v/1.0/function/change_card_acs_password	POST

Request

Parameter	M	Type	Length	Description
card_id	Y	N	20	Card ID.
key	Y	AN	16	Merchant API Key – provided by \nandName%.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
  "card_id": 22, 
  "key": "_MERCHANT_KEY_", 
  "ts": "_TIMESTAMP_", 
  "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	Possible values: success/error.
acs_password	Y	AN	255	Card ACS password. Must be encrypted using the 3DES algorithm with a 3DES key – provided by Paytriot.

{
  "status": "success", 
  "acs_password": "7H+Ft5z1Zq6\/uX52u2254A=="
}

Get status

Get card status by card ID.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_card_status

Request

Parameter	M	Type	Length	Description
card_id	Y	AN	20
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "card_id": 22,  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
card_status	Y	A	1	Possible values: A: activated, N: not activated, B: blocked, S: suspended, T: admin suspend (temporary blocked), E: expired.
card_status_decription	Y	A	40

{
   "status": "success",  
   "msg": "Success",  
   "card_status": "N",  
   "card_status_Description": "Not Activated"
}

Change card status

Change card status by card ID.

URL	Method
https://api.paytriot.co.uk/api/merchant/v/1.0/function/change_card_status	POST

Request

Parameter	M	Type	Length	Description
card_id	Y	N	20	Card ID.
status	Y	A	1	See Card status.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
  "card_id": 22, 
  "status": "S",
  "key": "_MERCHANT_KEY_", 
  "ts": "_TIMESTAMP_", 
  "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	Possible values: success/error.
msg	Y	AN	255	See Message code.
new_card_status	Y	N	1	New Card status.

{
  "status": "success",
  "msg": "Card status changed.",
  "new_card_status": "S"
}

Card (external)

Get list

Get all user external cards.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_user_external_cards

Request

Parameter	M	Type	Length	Description
username	Y	AN	100
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "username": "john.doe",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
cards	Y	LIST
id	Y	LIST
id	Y	N	20
number	Y	A	19	Partial card number.
status	Y	A	1	A: activated, N: not activated, B: blocked.

{
   "status": "success",  
   "msg": "Success",  
   "cards":{    
      "33209":{    
         "id": "33209",  
         "number": "**** **** **** 1199",  
         "status": "A"
      }  
   }
}

Verify

Verify previously linked external card.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/verify_external_card

Request

Parameter	M	Type	Length	Description
credit_card_id	Y	N	20
verification_amount	Y	N	10,2
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "credit_card_id": "33220",  
   "verification_amount": "0.66",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
description	N	AN
credit_card_id	Y	N	20

{
   "status": "success",  
   "msg": "External card has been verified",  
   "credit_card_id": "33220"
}

Direct debit

Status change

Change direct debit transaction status.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/direct_debit_status_change

Request

Parameter	M	Type	Length	Description
transaction_id	Y	N	20	Unique transaction ID.
should_pay	Y	N	1	Possible values: 1: yes, 0: no.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
    "transaction_id": 1166071,
    "should_pay": 1,
    "key": "_MERCHANT_KEY_",  
    "ts": "_TIMESTAMP_",  
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
transaction_id	Y	N	20	Unique transaction ID.

{
   "status": "success",  
   "msg": "Successfully changed direct debit `should_pay` status to 1",
   "transaction_id": 1166071
}

Direct debit mandate

Cancel

Cancel direct debit mandate.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/direct_debit_mandate_cancel

Request

Parameter	M	Type	Length	Description
mandate_id	Y	N	20
reason_code	Y	A	255	See Mandate cancelation reasons.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
    "mandate_id": 12345678910,
    "reason_code": "CANCELLED_BY_PAYER",
    "key": "_MERCHANT_KEY_",  
    "ts": "_TIMESTAMP_",  
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
mandate_id	Y	N	20

{
   "status": "success",  
   "msg": "Successfully requested to cancel direct debit mandate.",
   "mandate_id": 12345678910
}

Reject

Reject direct debit mandate.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/direct_debit_mandate_reject

Request

Parameter	M	Type	Length	Description
mandate_id	Y	N	20
reason_code	Y	A	255	See Mandate rejection reasons.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
    "mandate_id": 12345678910,
    "reason_code": "PAYER_ACCOUNT_CLOSED",
    "key": "_MERCHANT_KEY_",  
    "ts": "_TIMESTAMP_",  
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
mandate_id	Y	N	20

{
   "status": "success",  
   "msg": "Successfully requested to reject direct debit mandate.",
   "mandate_id": 12345678910
}

IBAN

Change status

Change IBAN status.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/iban_status_change

Request

Parameter	M	Type	Length	Description
iban	Y	AN	34	Bank account address - IBAN number.
status_id	Y	N	4	See IBAN statuses*.
currency_code	N	AN	3 - 3	ISO 4217
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

*Note: If IBAN has status suspended by admin (4), disabled (5) or suspended by system (7) status cannot be changed to any other.

{
    "iban": "GB888888888888888",
    "status_id": 1,
    "currency_code": null,
    "key": "_MERCHANT_KEY_",  
    "ts": "_TIMESTAMP_",  
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/ error.
msg	Y	AN	255	See Message code.
old_status_id	Y	N	4	See IBAN statuses.
new_status_id	Y	N	4	See IBAN statuses.
iban	Y	AN	34

{
   "status": "success",
   "msg": "Successfully requested to change IBAN status from 'Receive funds only' to 'Send and receive funds'.",
   "old_status_id": 2,
   "new_status_id": 1,
   "iban": "GB888888888888888"
}

Create

Create international bank account number.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/create_iban

Request

Parameter	M	Type	Length	Description
account_id	C	N	20	Required if 'currency' field is empty. Must be blank if 'accounts_ids' or 'currencies' fields are provided.
bank_account_holder_title	C	A	7	Mandatory when agreed with Paytriot.
bank_account_holder_first_name	C	A	50	Full legal name of the physical person.
bank_account_holder_last_name	C	A	50	Full legal name of the physical person.
bank_account_holder_address_line1	C	AN	70	Mandatory when agreed with Paytriot. Special symbols allowed: dashes, commas, dots and slashes.
bank_account_holder_address_line2	C	AN	70	Mandatory when agreed with Paytriot. Special symbols allowed: dashes, commas, dots and slashes.
bank_account_holder_address_line3	C	AN	70	Mandatory when agreed with Paytriot. Special symbols allowed: dashes, commas, dots and slashes.
bank_account_holder_address_line4	C	AN	70	Mandatory when agreed with Paytriot. Special symbols allowed: dashes, commas, dots and slashes.
bank_account_holder_postal_code	C	AN	9	Mandatory when agreed with Paytriot. Special symbols allowed: dashes.
bank_account_holder_city	C	AN	50	Mandatory when agreed with Paytriot. Special symbols allowed: dashes. Depends on provider.
bank_account_holder_state	C	AN	50	Mandatory when agreed with Paytriot. Special symbols allowed: dashes.
bank_account_holder_country_iso_code	C	N	3	ISO 3166-1 numeric code.
bank_account_holder_phone	C	AN	16	Phone number prefixed with +
internal_name	N	AN	100	This is the description of the account and is displayed in the Institution Portal only. Special symbols allowed: all symbols defined in Special symbols table, space.
currency	C	A	3	ISO 4217 - Required if 'account_id' field is empty. Must be blank if 'accounts_ids' or 'currencies' fields are provided.
account_holder_risk_score	N	N	1	Possible values: 1 - "low risk", 2 - "medium risk", 3 - "high risk"
request_reference	N	AN	255	Request reference. If this field is not empty - minimum length must be at least 10.
accounts_ids	C	AN		Required if 'account_id', 'currency' and 'currencies' fields are empty. Must be blank if 'account_id' or 'currency' fields are provided. Accounts separated with commas. Example: '123,456,759'
currencies	C	AN		ISO 4217 - Required if 'account_id', 'currency' and 'accounts_ids' fields are empty. Must be blank if 'account_id' or 'currency' fields are provided. Currencies separated with commas. Example: 'USD,EUR,CAD'
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
    "account_id": 1753154,
    "bank_account_holder_title": "",
    "bank_account_holder_first_name": "John",
    "bank_account_holder_last_name": "Doe",
    "bank_account_holder_address_line1": "Super str 115",
    "bank_account_holder_address_line2": "",
    "bank_account_holder_address_line3": "",
    "bank_account_holder_address_line4": "",
    "bank_account_holder_postal_code": "15452",
    "bank_account_holder_city": "London",
    "bank_account_holder_state": "",
    "bank_account_holder_country_iso_code": "004",
    "bank_account_holder_phone": "+4432611151",
    "internal_name": "John Doe IBAN account",
    "currency": "GBP",
    "account_holder_risk_score": 2,
    "request_reference": "123456789",
    "accounts_ids": "9153817, 9153818, 9153819",
    "currencies": "USD,EUR,CAD",
    "key": "_MERCHANT_KEY_",  
    "ts": "_TIMESTAMP_",  
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/ error.
msg	Y	AN	255	See Message code.
iban_request_id	Y	N	20
description	N	AN

{
   "status": "success",  
   "msg": "IBAN creation has been successfully requested.",
   "iban_request_id": 1234567
}

Update

Update international bank account number details.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/update_iban_details

Request

Parameter	M	Type	Length	Description
iban	Y	AN	34	Bank account address - IBAN number.
bank_account_holder_first_name	N	A	50	Available to change only for CENTROlink provider. Special symbols allowed: dashes, commas, dots and slashes.
bank_account_holder_last_name	N	A	50	Available to change only for CENTROlink provider. Special symbols allowed: dashes, commas, dots and slashes.
bank_account_holder_address_line1	N	AN	70	Special symbols allowed: dashes, commas, dots and slashes.
bank_account_holder_address_line2	N	AN	70	Special symbols allowed: dashes, commas, dots and slashes. Empty value is available.
bank_account_holder_address_line3	N	AN	70	Special symbols allowed: dashes, commas, dots and slashes. Empty value is available.
bank_account_holder_address_line4	N	AN	70	Special symbols allowed: dashes, commas, dots and slashes. Empty value is available.
bank_account_holder_postal_code	N	AN	9	Special symbols allowed: dashes.
bank_account_holder_city	N	AN	50	Special symbols allowed: dashes. Depends on provider.
bank_account_holder_state	N	AN	50	Special symbols allowed: dashes. Empty value is available.
bank_account_holder_country_iso_code	N	N	3	ISO 3166-1 numeric code.
bank_account_holder_phone	N	AN	16	Phone number prefixed with +
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
    "iban": "GB888888888888888",
    "bank_account_holder_first_name": "John",
    "bank_account_holder_last_name": "Joe",
    "bank_account_holder_address_line1": "Richland Avenue",
    "bank_account_holder_address_line2": "",
    "bank_account_holder_address_line3": null,
    "bank_account_holder_address_line4": null,
    "bank_account_holder_postal_code": "123457",
    "bank_account_holder_city": "Miami",
    "bank_account_holder_state": "",
    "bank_account_holder_country_iso_code": "004",
    "bank_account_holder_phone": "",
    "key": "_MERCHANT_KEY_",  
    "ts": "_TIMESTAMP_",  
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/ error.
msg	Y	AN	255	See Message code.
iban_id	Y	N	20	IBAN ID.
iban	Y	N	34	Bank account address - IBAN number.
description	N	AN

{
   "status": "success",  
   "msg": "Your IBAN details change has been successfully requested. You will be notified with iban details change webhook, when your details will be changed. (Address changes won't be shown)",
   "iban_id": 1234567,
   "iban": "GB888888888888888"
}

Create business

Create business international bank account number.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/create_business_iban

Request

Parameter	M	Type	Length	Description
account_id	C	N	20	Required if 'currency' field is empty. Must be blank if 'accounts_ids' or 'currencies' fields are provided.
business_name	Y	AN	50	Full legal name of the company.
internal_name	N	AN	100	This is the description of the account and is displayed in the Institution Portal only. Special symbols allowed: all symbols defined in Special symbols table, space.
currency	C	A	3	ISO 4217 - Required if 'account_id' field is empty. Must be blank if 'accounts_ids' or 'currencies' fields are provided.
bank_account_holder_address_line1	C	AN	70	Mandatory when agreed with Paytriot. Special symbols allowed: dashes, commas, dots and slashes.
bank_account_holder_address_line2	C	AN	70	Mandatory when agreed with Paytriot. Special symbols allowed: dashes, commas, dots and slashes.
bank_account_holder_address_line3	C	AN	70	Mandatory when agreed with Paytriot. Special symbols allowed: dashes, commas, dots and slashes.
bank_account_holder_address_line4	C	AN	70	Mandatory when agreed with Paytriot. Special symbols allowed: dashes, commas, dots and slashes.
bank_account_holder_postal_code	C	AN	9	Mandatory when agreed with Paytriot. Special symbols allowed: dashes.
bank_account_holder_city	C	AN	50	Mandatory when agreed with Paytriot. Special symbols allowed: dashes. Depends on provider.
bank_account_holder_state	C	AN	50	Mandatory when agreed with Paytriot. Special symbols allowed: dashes.
bank_account_holder_country_iso_code	C	N	3	Mandatory when agreed with Paytriot. ISO 3166-1 numeric code.
date_of_company_incorporation	N	AN	10	ISO 8601
industry_id	N	N	20	Use Get Industries action to know what kind of industries exist.
account_holder_risk_score	N	N	1	Possible values: 1 - "low risk", 2 - "medium risk", 3 - "high risk"
request_reference	N	AN	255	Request reference. If this field is not empty - minimum length must be at least 10.
accounts_ids	C	AN		Required if 'account_id', 'currency' and 'currencies' fields are empty. Must be blank if 'account_id' or 'currency' fields are provided. Accounts separated with commas. Example: '123,456,759'
currencies	C	AN		ISO 4217 - Required if 'account_id', 'currency' and 'accounts_ids' fields are empty. Must be blank if 'account_id' or 'currency' fields are provided. Currencies separated with commas. Example: 'USD,EUR,CAD'
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
    "account_id": 1753154,
    "business_name": "John Doe",
    "internal_name": "John Doe IBAN account",
    "currency": "GBP",
    "bank_account_holder_address_line1": "Super str 115",
    "bank_account_holder_address_line2": null,
    "bank_account_holder_address_line3": null,
    "bank_account_holder_address_line4": null,
    "bank_account_holder_postal_code": "123457",
    "bank_account_holder_city": "Miami",
    "bank_account_holder_state": "",
    "bank_account_holder_country_iso_code": "004",
    "date_of_company_incorporation": "2019-04-04",
    "industry_id": 10,
    "account_holder_risk_score": 2,
    "request_reference": "123456789",
    "accounts_ids": "9153817, 9153818, 9153819",
    "currencies": "USD,EUR,CAD",
    "key": "_MERCHANT_KEY_",  
    "ts": "_TIMESTAMP_",  
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/ error.
msg	Y	AN	255	See Message code.
iban_request_id	Y	N	20
description	N	AN

{
   "status": "success",  
   "msg": "Business IBAN creation has been successfully requested.",
   "iban_request_id": 1234567
}

Update business

Update business international bank account number details.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/update_business_iban_details

Request

Parameter	M	Type	Length	Description
iban	Y	AN	34	Bank account address - IBAN number.
business_name	N	AN	50	Available to change only for CENTROlink provider. Special symbols allowed: dashes, commas, dots and slashes.
bank_account_holder_address_line1	N	AN	70	Special symbols allowed: dashes, commas, dots and slashes. Empty value is available.
bank_account_holder_address_line2	N	AN	70	Special symbols allowed: dashes, commas, dots and slashes. Empty value is available.
bank_account_holder_address_line3	N	AN	70	Special symbols allowed: dashes, commas, dots and slashes. Empty value is available.
bank_account_holder_address_line4	N	AN	70	Special symbols allowed: dashes, commas, dots and slashes. Empty value is available.
bank_account_holder_postal_code	N	AN	9	Special symbols allowed: dashes. Empty value is available.
bank_account_holder_city	N	AN	50	Special symbols allowed: dashes. Empty value is available. Depends on provider.
bank_account_holder_state	N	AN	50	Special symbols allowed: dashes. Empty value is available.
bank_account_holder_country_iso_code	N	N	3	ISO 3166-1 numeric code. Empty value is available.
industry_id	N	N	20	Use Get Industries action to know what kind of industries exist. Use 0 value to remove industry.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
    "iban": "GB888888888888888",
    "business_name": "",
    "bank_account_holder_address_line1": "Richland Avenue",
    "bank_account_holder_address_line2": "",
    "bank_account_holder_address_line3": "",
    "bank_account_holder_address_line4": null,
    "bank_account_holder_postal_code": "123457",
    "bank_account_holder_city": "Miami",
    "bank_account_holder_state": "",
    "bank_account_holder_country_iso_code": "004",
    "industry_id": null,
    "key": "_MERCHANT_KEY_",  
    "ts": "_TIMESTAMP_",  
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/ error.
msg	Y	AN	255	See Message code.
iban_id	Y	N	20	IBAN ID.
iban	Y	N	34	Bank account address - IBAN number.
description	N	AN

{
   "status": "success",  
   "msg": "Your IBAN details change has been successfully requested. You will be notified with iban details change webhook, when your details will be changed. (Address changes won't be shown)",
   "iban_id": 1234567,
   "iban": "GB888888888888888"
}

Get by request ID

Get your international bank account number by request ID.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_iban_by_request_id

Request

Parameter	M	Type	Length	Description
iban_request_id	C	N	20	Required if field request_reference is empty.
request_reference	C	AN	255	Required if field iban_request_id is empty.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
    "iban_request_id": 12345678910,
    "request_reference": "RREF12345679",
    "key": "_MERCHANT_KEY_",  
    "ts": "_TIMESTAMP_",  
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/ error.
msg	Y	AN	255	See Message code.
description	N	AN	255
iban_request_status	N	N	20	Will be shown if IBAN will not be found. See IBAN request status
error_message	N	AN	255	Will be shown if IBAN will not be found. Error message why IBAN failed to be created
data	Y	LIST
iban	Y	AN	34	IBAN number
account_id	Y	N	20
currency_code	Y	A	3	ISO 4217
status_id	Y	N	4	See IBAN statuses.

{
   "status": "success",
   "msg": "Successfully found your IBAN.",
   "iban_request_status": 2,
   "error_message": "Field `bank_account_holder_state` is invalid.",
   "data": {
       "iban": "GB888888888888888",
       "account_id": 1753154,
       "currency_code": "GBP",
       "status_id": 1
   }
}

Get list

Get list of your international bank account numbers.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_ibans_list

Request

Parameter	M	Type	Length	Description
item_count	N	N	3	Items count per page. Max is 100. Default is 10.
current_items_page	N	N	20	Default is 1.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
    "item_count": 10,
    "current_items_page": 1,
    "key": "_MERCHANT_KEY_",  
    "ts": "_TIMESTAMP_",  
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/ error.
msg	Y	AN	255	See Message code.
description	N	AN	255
data	Y	LIST
list	Y	LIST		List of IBANs
iban	Y	AN	34	IBAN number
account_id	Y	N	20	Account ID.
currency_code	Y	A	3	ISO 4217
status_id	Y	N	4	See IBAN statuses.
paginator	Y	LIST		Paginator details
limit	Y	N	3	Current limitation value. Max 100.
current_page	Y	N	20

{
   "status": "success",
   "msg": "Successfully loaded your IBAN's list",
   "data": {
       "list": [
           {
               "iban": "GB888888888888888",
               "account_id": 1753154,
               "currency_code": "GBP",
               "status_id": 2
           },
           {
               "iban": "GB999999999999999",
               "account_id": 1753242,
               "currency_code": "GBP",
               "status_id": 1
           }
       ],
       "paginator": {
           "limit": 10,
           "current_page": 1
       }
   }
}

Verify bank account address

Verify the exact holder name registered with the payee’s account.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/verify_bank_account_address

Request

Parameter	M	Type	Length	Description
iban	N	AN	34	Bank account address IBAN. Must be provided if sort_code and account_number are null.
sort_code	N	N	6	Bank account address sort_code. Must be provided if IBAN is null.
account_number	N	N	8	Bank account address account_number. Must be provided if IBAN is null.
legal_owner_type	Y	N	8	LegalOwnerType
account_name	Y	N	140	Name of the bank account address owner.
request_reference	N	N	140	A unique value which can be used to identify the request and then used in any subsequent payment initiations to link them to this request.
key	Y	AN	16	Merchant API Key provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
    "sort_code": "040404",
    "account_number": "12345678",
    "legal_owner_type": "PERSONAL",
    "account_name": "John Smith",
    "key": "_MERCHANT_KEY_", 
    "ts": "_TIMESTAMP_", 
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/ error.
msg	N	AN	255	See Message code.
confirmation_of_payee_id	Y	N	20	Unique scan ID.
matched	N	AN	1	True if there is a match. False if there is no match or a partial match.
name	N	AN	255	The account holder name in case of a partial match. This will not be present if there is a true match.
reason_code	N	AN	255	Reason code for a more detailed description of the kind of match. Defined by Pay.UK Provided if there is no match or a partial match. This will not be present if there is a true match.
reason_code_description	N	AN	255	Detailed description of the reason code, as described by Pay.UK Provided if there is no match or a partial match. This will not be present if there is a true match.
matched_bank	Y	AN	255	The name of the bank with which the name verification was performed.

{
  "status": "success",
  "confirmation_of_payee_id": "123123123",
  "matched": true,
  "matched_bank": "Barclays"
}

Opt out bank account address

Opt out/in of Confirmation of Payee (CoP) service for IBAN.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/opt_out_bank_account_address

Request

Parameter	M	Type	Length	Description
iban_id	N	N	20	Unique IBAN ID.
opt_out	N	AN	5	Determines whether to opt out of or opt in to the Confirmation of Payee service. Available values: true - opt out, false - opt in.
opt_out_reason	C	AN	200	Reason of the change. Mandatory when opt_out = true.
key	Y	AN	16	Merchant API Key provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation

{
    "iban_id": "123123123",
    "opt_out": "true",
    "opt_out_reason": "Irrelevant for this account",
    "key": "_MERCHANT_KEY_", 
    "ts": "_TIMESTAMP_", 
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/ error.
msg	N	AN	255	See Message code.

{
  "status": "success"
}

IBAN transfer

Inbound cancel

Approve

Approve inbound cancel request for IBAN to account transaction.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/approve_inbound_cancel_request

Request

Parameter	M	Type	Length	Description
cancel_request_id	Y	N	20
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "cancel_request_id": 1234567890,
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/ error.
msg	Y	AN	255	See Message code.
cancel_transaction_id	Y	N	20	Unique transaction ID.

{
   "status": "success",  
   "msg": "Cancel request approve was successfully requested.",  
   "cancel_transaction_id": "1166071"
}

Decline

Decline inbound cancel request for IBAN to account transaction.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/decline_inbound_cancel_request

Request

Parameter	M	Type	Length	Description
cancel_request_id	Y	N	20
decline_reason_code	Y	N	20	See Inbound cancel request decline reason codes
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "cancel_request_id": 1234567890,
   "decline_reason_code": 650,
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/ error.
msg	Y	AN	255	See Message code.
cancel_instruction_id	Y	N	20

{
   "status": "success",  
   "msg": "Cancel request was successfully requested to be declined.",
   "cancel_instruction_id": "123456"
}

Outbound cancel

Initiate outbound cancel request for account to IBAN transaction.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/outbound_transfer_cancel

Request

Parameter	M	Type	Length	Description
transaction_id	Y	N	20	Unique transaction ID.
cancel_reason_code	Y	N	20	See Outbound cancel request reason codes
reason_additional_information	N	AN	105	See Outbound cancel request reason codes which require this field.
reason_originator_name	N	AN	70	See Outbound cancel request reason codes which require this field.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
  "transaction_id": 1166071,
  "cancel_reason_code": 672,
  "reason_additional_information": "Additional information for specific outbound cancel request reason",
  "reason_originator_name": "Originator name for specific outbound cancel request reason",
  "key": "_MERCHANT_KEY_",  
  "ts": "_TIMESTAMP_",  
  "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
cancel_transaction_id	Y	N	20	Unique transaction ID.

{
   "status": "success",  
   "msg": "Outbound cancel was successfully requested",  
   "cancel_transaction_id": "1166071"
}

Direct debit return

Returns a previously received direct debit payment.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/transfer_iban_direct_debit_return

Request

Parameter	M	Type	Length	Description
transaction_id	Y	N	20	Unique transaction ID.
reason	Y	AN	3	See IBAN direct debit return message codes.
request_reference	N	AN	255	Request reference. If this field is not empty - minimum length must be at least 10. Will be returned with return webhooks as 'return_request_reference' field.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "transaction_id": 1166071,
   "reason": "650",
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
transaction_id	Y	N	20	Unique transaction ID.

{
   "status": "success",  
   "msg": "Successfully requested to return direct debit transfer",  
   "transaction_id": "1166071"
}

Industry

Get list

Get list of industries.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_industries

Request

Parameter	M	Type	Length	Description
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
    "key": "_MERCHANT_KEY_",  
    "ts": "_TIMESTAMP_",  
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/ error.
msg	Y	AN	255	See Message code.
description	N	AN	255
list	Y	LIST		List of industries.
id	Y	N	20	Industry ID.
name	Y	AN	100	Industry name.

{
  "status": "success",
  "msg": "Successfully loaded industries's list",
  "list": [
    {
      "id": "1",
      "name": "Travel services"
    },
    {
      "id": "2",
      "name": "Financial services"
    },
    {
      "id": "3",
      "name": "Computer services"
    },
    {
      "id": "4",
      "name": "Insurance services"
    },
    {
      "id": "5",
      "name": "Rental services"
    },
    {
      "id": "6",
      "name": "Charities"
    },
    {
      "id": "7",
      "name": "Accountants"
    },
    {
      "id": "8",
      "name": "Trusts"
    },
    {
      "id": "9",
      "name": "Pharmaceutical services"
    },
    {
      "id": "10",
      "name": "Gambling\/Betting"
    },
    {
      "id": "11",
      "name": "Adult services"
    },
    {
      "id": "12",
      "name": "Telemarketing services"
    },
    {
      "id": "13",
      "name": "Crypto activity"
    },
    {
      "id": "14",
      "name": "Foreign exchange"
    },
    {
      "id": "15",
      "name": "Retail"
    },
    {
      "id": "16",
      "name": "Healthcare & Social services"
    },
    {
      "id": "17",
      "name": "Public catering"
    },
    {
      "id": "18",
      "name": "Other"
    }
  ]
}

Notification

Request email

Send requested email message to merchant sponsored account.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/request_email

Request

Parameter	M	Type	Length	Description
user_id	Y	N	20	Email receiver user ID.
type	Y	AN	9	Email type. 'accountbal' : request account balance, 'cardbal' : request card balance, 'pincode' : request Paytriot MasterCard PIN code, 'accounttx' : request account recent transactions, 'cardtx' : request Paytriot MasterCard recent transactions.
id	Y	N	20	Account ID or last 4 digits of Paytriot. MasterCard
order	N	N	1	1, 2, or 3 to indicate if you want request the most recent, second to last or third to last transaction.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "user_id": "1000001",  
   "type": "acountbal",  
   "id": "1753154",  
   "order ": "1",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
code	N	N	3	See Message code.
msg	Y	AN	255	See Message code.

{
   "status": "success",  
   "msg": "Email sent"
}

Request SMS

Send requested SMS message to merchant sponsored account.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/request_sms

Request

Parameter	M	Type	Length	Description
user_id	Y	N	20	SMS receiver user ID.
type	Y	AN	9	SMS type. 'accountbal' : request account balance, 'cardbal' : request card balance, 'pincode' : request Paytriot MasterCard PIN code, 'accounttx' : request account recent transactions, 'cardtx' : request Paytriot MasterCard recent transactions.
id	Y	N	20	Account ID or last 4 digits of Paytriot. MasterCard
order	N	N	1	1, 2, or 3 to indicate if you want request the most recent, second to last or third to last transaction.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "user_id": "1000001",  
   "type": "accountbal",  
   "id": "1753154",  
   "order ": "1",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
code	N	N	3	See Message code.
msg	Y	AN	255	See Message code.

{
   "status": "success",  
   "msg": "SMS successfully sent"
}

Send email

Send email message to merchant sponsored account.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/send_email

Request

Parameter	M	Type	Length	Description
id	Y	N	20	Email receiver account ID or card ID.
type	Y	N	1	ID type 1 : account ID, 2 : card ID.
subject	Y	AN	78	Email subject.
message	Y	AN		Email message. Available tags: account_id, username, firstname, lastname, balance, pin_code.
tx_id	N	N	20	Transaction ID*.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

*Note: in this case id is provided, you can use tags: tx_id, tx_amount and tx_currency in your message, which will be replaced by tx_id, transaction amount and transaction currency.

{
   "id": "1753154",  
   "type": "1",  
   "subject": "test subject",  
   "message": "test message",  
   "tx_id": "2001",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	Message.

{
   "status": "success",  
   "msg": "Email successfully sent"
}

Send SMS

Send SMS message to merchant sponsored account.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/send_sms

Request

Parameter	M	Type	Length	Description
id	Y	N	20	SMS receiver account ID or card ID.
type	Y	N	1	ID type 1 : account ID, 2 : card ID.
message	Y	AN	1600	SMS Message*.
tx_id	N	N	20	Transaction ID**.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

*Note: Messages with one or more non-GSM characters are limited to 70 characters. Any SMS messages that include 1 or more non-GSM characters will be separated into messages of 70 characters or less. Available tags: account_id, username, firstname, lastname, balance, pin_code.

**Note: in this case id is provided, you can use tags: tx_id, tx_amount and tx_currency in your message, which will be replaced by tx_id, transaction amount and transaction currency.

{
   "id": "1753154",  
   "type": "1",  
   "message": "test message",  
   "tx_id": "2001",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
code	N	N	3	See Message code.
msg	Y	AN	255	See Message code.

{
   "status": "success",  
   "msg": "Message successfully sent"
}

Report

Account activity

Returns list of account transactions from period (max 31 day).

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_account_activity

Request

Parameter	M	Type	Length	Description
account	Y	N	20	Account ID.
date_from	Y	AN	10	ISO 8601
date_to	Y	AN	10	ISO 8601
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "account": "1753154",
   "date_from": "2015-06-10",
   "date_to": "2015-06-13",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
totals	Y	LIST		Totals for filtered period.
total_count	Y	N	11	Number of transactions.
rejected_count	Y	N	11	Number of rejected transactions.
sum_credits	Y	N	11	Total credited amount.
sum_debits	Y	N	11	Total debited amount.
count_credits	Y	N	11	Number of credit transactions.
count_debits	Y	N	11	Number of debit transactions.
activity	Y	[ ]		List of transactions.
id	Y	N	20	Transaction ID.
parent_tx_id	N	N	20	Parent transaction ID.
transaction_type	N	AN	15	Transaction type. See Payment transaction types.
Is_rejected	Y	N	1	Is transaction rejected.
date	Y	AN	10	ISO 8601
datetime	Y	N	11	Unix timestamp.
sender	Y	AN	20	Account ID or card number of sender.
recipient	Y	AN	20	Account ID or card number of recipient.
debit	Y	N	11	Amount debited.
credit	Y	N	11	Amount credited.
currency	Y	A	3	ISO 4217
description	Y	A	100	Description.
additional_info	N	LIST		Additional information for iban transactions.
source_mandate_originator	N	LIST		Source mandate originator information
sender_originator_id	N	N	20
sender_originator_name	N	AN	255
sender_originator_service_user_number	N	N	6	Unique reference, which identifies originator
destination_mandate	N	LIST		Destination mandate information
destination_mandate_id	N	N	20
destination_mandate_originator	N	LIST		Destination mandate originator information
destination_mandate_originator_id	N	N	20
destination_mandate_originator_name	N	AN	255
destination_mandate_originator_service_user_number	N	N	6	Unique reference, which identifies originator
destination_mandate_reference	N	AN	18	Mandate's reference
destination_mandate_request_reference	N	AN	255	Request reference that has been provided in Mandate creation call.
destination_mandate_status	N	N	20	See Mandate statuses.
destination_mandate_type	N	N	20	See Mandate types
sender_data	N	LIST		Sender details
iban_id	N	N	20	Sender's - IBAN ID
iban	N	AN	34	Sender's - Bank account address - IBAN number
account_name	N	A	40	Sender's - Bank account address - Account name
account_number	N	N	26	Sender's - Bank account address - Account number
sort_code	N	N	6	Sender's - Bank account address - Sort code.
bic	N	AN	12	Sender's - Bank account address - BIC code.
receiver_data	N	LIST		Receiver details
iban_id	N	N	20	Receiver's - IBAN ID
iban	N	AN	34	Receiver's - Bank account address - IBAN number
account_name	N	A	40	Receiver's - Bank account address - Account name
account_number	N	N	26	Receiver's - Bank account address - Account number
sort_code	N	N	6	Receiver's - Bank account address - Sort code.
bic	N	AN	12	Receiver's - Bank account address - BIC code.
return_details	N	AN	255	Returned transaction details
reason_code	N	N	3	See IBAN Inbound return message codes or see IBAN Outbound return message codes
transaction_details	N	LIST		Transaction details
senderData	N	LIST		Transaction details sender data
name	N	AN	255	Sender's name
iban	N	AN	34	Sender's iban
addressLineOne	N	AN	255	Sender's address
addressLineTwo	N	AN	255	Sender's
country	N	AN	3	Sender's country. ISO 3166-1 numeric code
receiverData	N	LIST		Transaction details receiver data
name	N	AN	255	Receiver's name
iban	N	AN	34	Receiver's iban
addressLineOne	N	AN	255	Receiver's address
addressLineTwo	N	AN	255	Receiver's
country	N	AN	3	Receiver's country. ISO 3166-1 numeric code
purpose	N	AN	4	Transaction details purpose. ISO 20022 external purpose code
note	N	AN	255	Transaction details note. This field is for remittance information.
reference	N	AN	255	Transaction reference
request_reference	N	AN	255	Transaction request reference
transaction_identifier	N	AN	100	Unique external transaction identifier
end_to_end_identifier	N	AN	100	Transaction's end to end identifier
tx_scheme	N	N	2	See IBAN transfer schemes.
tx_created_date	N	AN	10	ISO 8601
tx_created_datetime	N	N	11	Unix timestamp.
tx_updated_date	N	AN	10	ISO 8601
tx_updated_datetime	N	N	11	Unix timestamp.
is_status_settled	N	N	1	Is transaction settled? Possible values: 0 or 1
is_status_pending	N	N	1	Is transaction pending? Possible values: 0 or 1
is_status_reversal	N	N	1	Is transaction reversed? Possible values: 0 or 1
is_status_held	N	N	1	Is transaction on hold? Possible values: 0 or 1
is_cancellation	N	N	1	Is cancellation transaction? Possible values: 0 or 1
is_return	N	N	1	Is transaction returned? Possible values: 0 or 1
is_direct_credit	N	N	1	Is direct credit transaction? Possible values: 0 or 1
is_direct_debit	N	N	1	Is direct debit transaction? Possible values: 0 or 1

{
   "status": "success",  
   "msg": "Success",  
   "totals":{    
      "total_count": 2,  
      "rejected_count": 0,  
      "sum_credits": -1160.82,  
      "sum_debits": 1160.82,  
      "count_credits": 1,  
      "count_debits": 1  
   },  
   "activity":[    
      {    
         "id": "4320",  
         "parent_tx_id": null,
         "transaction_type": "a2a",
         "is_rejected": "0",  
         "date": "2015-06-13",  
         "datetime": "1434197442",  
         "sender": "1753154",  
         "recipient": "1753242",  
         "debit": "",  
         "credit": "-1160.82",  
         "currency": "USD",  
         "description": "Account (1753154) to account (1753242) transaction",
         "additional_info": null
      },  
      {    
         "id": "4140",  
         "parent_tx_id": null,
         "transaction_type": "ba2a",
         "is_rejected": "0",  
         "date": "2015-06-13",  
         "datetime": "1434192457",  
         "sender": "",  
         "recipient": "1753242",  
         "debit": "1160.82",  
         "credit": "",  
         "currency": "USD",  
         "description": "Confirmed bank account to account transfer",
         "additional_info": null  
      },
      {
        "id": 12345678910,
        "parent_tx_id": null,
        "transaction_type": "a2iban",
        "is_rejected": 0,
        "date": "2015-06-13",
        "datetime": 1434192457,
        "sender": "12345678",
        "recipient": "",
        "debit": null,
        "credit": "-6.51",
        "currency": "GBP",
        "description": "Transfer from Account (1753154) to Bank Account (account number - 78726600, sort code - 660011)",
        "additional_info": {
          "source_mandate_originator":{
            "id":15890083898187,
            "name":"PARTNERSHIP EDUCAT",
            "service_user_number":"162631"
          },
          "sender_data": {
            "iban_id": 12345678910,
            "iban": "GB77777777777777777",
            "account_name": "John Doe",
            "account_number": "78726600",
            "sort_code": "660011",
            "bic": "SR123457"
          },
          "receiver_data": {
            "iban_id": null,
            "iban": null,
            "account_name": "John Joe",
            "account_number": "78726711",
            "sort_code": "671100",
            "bic": null
          },
          "return_details": null,
          "reason_code": null,
          "transaction_details": {
            "sender_data": {
              "name": null,
              "iban": "GB77777777777777777",
              "country": null,
              "address_line_one": null,
              "address_line_two": null
            },
            "receiver_data": {
              "name": "John Joe",
              "iban": null,
              "country": "004",
              "address_line_one": null,
              "address_line_two": null
            },
            "note": "message for receiver",
            "purpose": "MWP"
          },
          "reference": "BB12345678",
          "request_reference": "BB123456789",
          "transaction_identifier": "TX123456789",
          "end_to_end_identifier": null,
          "tx_scheme": 3,
          "tx_created_date": "2015-06-13",
          "tx_created_datetime": 1434192457,
          "tx_updated_date": "2015-06-13",
          "tx_updated_datetime": 1434192457,
          "is_status_settled": 1,
          "is_status_pending": 0,
          "is_status_reversal": 0,
          "is_status_held": 0,
          "is_cancellation": 0,
          "is_return": 0,
          "is_direct_credit": 0,
          "is_direct_debit": 0
        }
    },
    {
        "id": 12345678911,
        "parent_tx_id": null,
        "transaction_type": "a2directdebit",
        "is_rejected": 0,
        "date": "2015-06-13",
        "datetime": 1434192457,
        "sender": "12345678",
        "recipient": "",
        "debit": null,
        "credit": "-6.51",
        "currency": "GBP",
        "description": "Direct debit transfer from Account (1753154) for Mandate (name - Test, reference - Test mandate)",
        "additional_info": {
          "source_mandate_originator": null,
           "destination_mandate":{
               "id":15958372760595,
               "originator":{
                   "id":15958372760590,
                   "name":"John",
                   "service_user_number":"777777"
               },
               "reference":"Test mandate",
               "request_reference":null,
               "status":1,
               "type":2
           },
          "sender_data": {
            "iban_id": 12345678910,
            "iban": "GB77777777777777777",
            "account_name": "John Doe",
            "account_number": "78726600",
            "sort_code": "660011",
            "bic": "SR123457"
          },
          "receiver_data": {
            "iban_id": null,
            "iban": null,
            "account_name": "John Joe",
            "account_number": "78726711",
            "sort_code": "671100",
            "bic": null
          },
          "return_details": null,
          "reason_code": null,
          "transaction_details": {
            "sender_data": {
              "name": null,
              "iban": "GB77777777777777777",
              "country": null,
              "address_line_one": null,
              "address_line_two": null
            },
            "receiver_data": {
              "name": "John Joe",
              "iban": null,
              "country": "004",
              "address_line_one": null,
              "address_line_two": null
            },
            "note": "message for receiver",
            "purpose": "MWP"
          },
          "reference": "BB12345678",
          "request_reference": "BB123456789",
          "transaction_identifier": "TX123456789",
          "end_to_end_identifier": null,
          "tx_scheme": 4,
          "tx_created_date": "2015-06-13",
          "tx_created_datetime": 1434192457,
          "tx_updated_date": "2015-06-13",
          "tx_updated_datetime": 1434192457,
          "is_status_settled": 1,
          "is_status_pending": 0,
          "is_status_reversal": 0,
          "is_status_held": 0,
          "is_cancellation": 0,
          "is_return": 0,
          "is_direct_credit": 0,
          "is_direct_debit": 1
        }
    }
   ]
}

Account last activity

Returns list of 10 latest account transactions.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_account_last_activity

Request

Parameter	M	Type	Length	Description
account	Y	N	20	Account ID.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "account": "1753154",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
activity	Y	[ ]		List of transactions.
id	Y	N	20	Transaction ID.
date	Y	AN	10	ISO 8601
datetime	Y	N	11	Unix timestamp.
sender	Y	AN	20	Account ID or Card number of sender.
recipient	Y	AN	20	Account ID or Card number of recipient.
debit	Y	N	11	Amount debited.
credit	Y	N	11	Amount debited.
currency	Y	A	3	ISO 4217
description	Y	A	100	Description.

{
   "status": "success",  
   "msg": "Success",  
   "activity":[    
      {    
         "id": "4320",  
         "date": "2015-06-13",  
         "datetime": "1434197442",  
         "sender": "1753154",  
         "recipient": "1753242",  
         "debit": "",  
         "credit": "-1160.82",  
         "currency": "USD",  
         "description": "Account (1753154) to account(1753242) transaction"  
      },  
      {    
         "id": "4140",  
         "date": "2015-06-13",  
         "datetime": "1434192457",  
         "sender": "",  
         "recipient": "1753242",  
         "debit": "1160.82",  
         "credit": "",  
         "currency": "USD",  
         "description": "Confirmed bank account to account transfer"  
      }  
   ]
}

Card activity

Returns list of card transactions from period (max 31 day).

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_card_activity

Request

Parameter	M	Type	Length	Description
card_id	Y	N	20
date_from	Y	AN	10	ISO 8601
date_to	Y	AN	10	ISO 8601
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "card_id": "1001",
   "date_from": "2015-06-13",
   "date_to": "2015-06-16",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
totals	Y	LIST		Totals for filtered period.
total_count	Y	N	11	Number of transactions.
rejected_count	Y	N	11	Number of rejected transactions.
sum_credits	Y	N	11	Total credited amount.
sum_debits	Y	N	11	Total debited amount.
count_credits	Y	N	11	Number of credit transactions.
count_debits	Y	N	11	Number of debit transactions.
activity	Y	[ ]		List of transactions.
id	Y	N	20	Transaction ID.
parent_tx_id	N	N	20	Parent transaction ID.
transaction_type	N	AN	15	Transaction type. See Payment transaction types.
is_rejected	Y	N	1	Is transaction rejected.
date	Y	AN	10	ISO 8601
datetime	Y	N	11	Unix timestamp.
sender	Y	AN	20	Account ID or card number of sender.
recipient	Y	AN	20	Account ID or card number of recipient.
debit	Y	N	11	Amount debited.
credit	Y	N	11	Amount credited.
currency	Y	A	3	ISO 4217
description	Y	A	100	Description.

{
   "status": "success",  
   "msg": "Success",  
   "totals":{    
      "total_count": 2,  
      "rejected_count":0,  
      "sum_credits":-116.02,  
      "sum_debits": 120.24,  
      "count_credits": 1,  
      "count_debits": 1  
   },  
   "activity":[    
      {    
         "id": "4320",
         "parent_tx_id": null,
         "transaction_type": "c2a",  
         "is_rejected": "0",  
         "date": "2015-06-16",  
         "datetime": "1434157436",  
         "sender": "000000******1234",  
         "recipient": "1753242",  
         "debit": "",  
         "credit": "-116.02",  
         "currency": "USD",  
         "description": "Card (000000******1234) to account (1753242) transaction"  
      },  
      {    
         "id": "4140",  
         "parent_tx_id": null,
         "transaction_type": "a2c",  
         "is_rejected": "0",  
         "date": "2015-06-13",  
         "datetime": "1434192457",  
         "sender": "1753154",  
         "recipient": "000000******1234",  
         "debit": "120.24",  
         "credit": "",  
         "currency": "USD",  
         "description": "Account (1753154) to card (000000******1234) transaction"  
      }  
   ]
}

Card last activity

Returns list of 10 latest card transactions.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_card_last_activity

Request

Parameter	M	Type	Length	Description
card_id	Y	N	20
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "card_id": "1001",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
activity	Y	[ ]		List of transactions.
id	Y	N	20	Transaction ID.
date	Y	AN	10	ISO 8601
datetime	Y	N	11	Unix timestamp.
sender	Y	AN	20	Account ID or card number of sender.
recipient	Y	AN	20	Account ID or card number of recipient.
debit	Y	N	11	Amount debited.
credit	Y	N	11	Amount debited.
currency	Y	A	3	ISO 4217
description	Y	A	100	Description.

{
   "status": "success",  
   "msg": "Success",  
   "activity":[    
      {    
         "id": "4320",  
         "date": "2015-06-16",  
         "datetime": "1434157436",  
         "sender": "000000******1234",  
         "recipient": "1753242",  
         "debit": "",  
         "credit": "-116.02",  
         "currency": "USD",  
         "description": "Card (000000******1234) to account (1753242) transaction"  
      },  
      {    
         "id": "4140",  
         "date": "2015-06-13",  
         "datetime": "1434192457",  
         "sender": "1753154",  
         "recipient": "000000******1234",  
         "debit": "120.24",  
         "credit": "",  
         "currency": "USD",  
         "description": "Account (1753154) to card (000000******1234) transaction"  
      }  
   ]
}

Purchase status

Gets purchase status.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_purchase_status

Request

Parameter	M	Type	Length	Description
reference_id	Y	AN	255	Unique ID of the purchase request.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "reference_id": "ap-57fce78057df6"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
reference_id	Y	AN	255	Unique ID of the purchase request.
order_id	Y	A	50	Unique order ID.
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
purchase_status	Y	N	11	See Purchase status.

{
   "status": "success",
   "msg": "Success",
   "reference_id": "ap-57fce78057df6",
   "order_id": "my_order_81815",
   "amount": "1.01",
   "currency": "USD",     
   "purchase_status": 9   
}

Transaction status

Get transaction status by transaction ID.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_transaction_status

Request

Parameter	M	Type	Length	Description
transaction_id	Y	AN	20	Unique transaction ID.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "transaction_id": "1166071",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
transaction_status	Y	A	1	Possible values: C: completed, P: pending, U: under review, R: rejected.
transaction_code	Y	A	3	See Message code.
transaction_status_desc	Y	N	50
test	Y	A	1	Possible values: Y: yes N: no.

{
   "status": "success",  
   "msg": "Success",  
   "transaction_status": "C",  
   "transaction_code": "000",  
   "transaction_status_desc": "Transaction successfully completed",  
   "test": "N"
}

Transaction status by ID or Request reference

Get transaction status by transaction ID or by Request reference.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_transaction_status_by_ref_or_id

Request

Parameter	M	Type	Length	Description
transaction_id	N	N	20
request_reference	N	AN	255	Transaction request reference.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "transaction_id": 22,  
   "request_reference": null,  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	Success/error.
msg	Y	AN	255	See Message code.
transaction_id	Y	N	20
request_reference	Y	AN	255
transactions_status	Y	N	20	See IBAN transaction status.

{
   "status": "success",  
   "msg": "Transaction has been found successfully.",  
   "transaction_id": 22,  
   "request_reference": "AAA12345789",  
   "transactions_status": "6"
}

Simulate

Webhook

IBAN inbound reversed

Simulates iban to account transfer reverse and triggers iban-inbound-reverse webhook.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/simulate_webhook_iban_inbound_reversed

Request

Parameter	M	Type	Length	Description
transaction_id	Y	N	20	Unique transaction ID.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "transaction_id": "1166071",
   "key": "_MERCHANT_KEY_",
   "ts": "_TIMESTAMP_",
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.

{
   "status": "success",
   "msg": "Your simulation was successfully requested."
}

IBAN inbound settled

Simulates IBAN to account transfer and triggers iban-inbound-settled webhook.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/simulate_webhook_iban_inbound_settled

Request

Parameter	M	Type	Length	Description
amount	Y	N	10,2
sender_iban	Y	AN	34	Sender's bank account address - IBAN number.
receiver_iban	Y	AN	34	Receiver's bank account address - IBAN number.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "amount": "50.55",
   "sender_iban": "GB999999999999999",
   "receiver_iban": "GB888888888888888",
   "key": "_MERCHANT_KEY_",
   "ts": "_TIMESTAMP_",
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.

{
   "status": "success",
   "msg": "Your simulation was successfully requested."
}

Transfer

Account to ...

Account

Create

Initiate account to account transfer.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/transfer_a_to_a

Request

Parameter	M	Type	Length	Description
sender_account	Y	N	20	From account ID.
receiver_account	Y	N	20	To account ID.
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
test	Y	N	1	Is it test transaction? Possible values: 1- yes, 0- no.
description	N	AN	255	Description for transaction details.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "sender_account": "1753154",  
   "receiver_account": "1753242",  
   "amount": 15.00,  
   "currency": "USD",  
   "test": 0,
   "description": "Account to account transaction",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
transaction_id	Y	A	20	Unique transaction ID.

{
   "status": "success",  
   "msg": "Operation completed.",  
   "transaction_id": "1166071"
}

Create purchase

Initiates purchase procedure.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/create_purchase

Request

Parameter	M	Type	Length	Description
receiver_account	Y	N	20	Your account ID for receiving transfer.
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
order_id	Y	A	50	Unique order ID.
sender_user_id	N	N	20	Paytriot user ID.
sender_account	N	N	20	Paytriot account ID.
url_user_on_success	N	A	255	URL where user will returned after successful purchase.
url_user_on_fail	N	A	255	URL where user will returned in case of failed purchase.
url_api_on_success	N	A	255	URL where will be sent IPN (instant payment notification) in case of successfully completed purchase. See IPN catcher PHP code example".
url_api_on_fail	N	A	255	URL where will be sent IPN (instant payment notification) in case of failed or canceled purchase. See IPN catcher PHP code example".
language	N	A	2	Preferred language. If not provided – English will be used.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "receiver_account": "1753154",  
   "amount": "1.01",  
   "currency": "USD",
   "order_id": "my_order_81815",  
   "sender_user_id": "",
   "sender_account": "",  
   "url_user_on_success": "https://www.myeshopexample.com/success_purchase",  
   "url_user_on_fail": "https://www.myeshopexample.com/failed_purchase",  
   "url_api_on_success": "https://www.myeshopexample.com/ipn_success_purchase",  
   "url_api_on_fail": "https://www.myeshopexample.com/ipn_failed_purchase",  
   "language": "en",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
reference_id	Y	AN	16	Unique ID of the purchase request.
order_id	Y	A	50	Unique order ID.
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
purchase_status	Y	N	11	See Purchase status.
url	Y	AN	255	URL where user can finish or cancel his purchase (encode this URL using base64_encode function and redirect to Paytriot login page with additional redirect param, e.g.: https://wallet.paytriot.co.uk/en/auth/login/redirect/_base64_encoded_url).

{
   "status": "success",  
   "msg": "Success",  
   "reference_id": "ap-57fce78057df6",
   "order_id": "my_order_81815",
   "amount": "1.01",
   "currency": "USD",  
   "purchase_status": 1,
   "url": "https://wallet.paytriot.co.uk/en/purchase/confirmpurchase/ref/ap-57fce78057df6"
}

External initialize

Prepare transfer from any user to merchant account.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/initialize_transfer

Request

Parameter	M	Type	Length	Description
receiver_account	Y	N	20	Your account ID for receiving transfer.
sender	Y	AN	100	Here can be username, user email or account number from which made transfer. If user did not have requested currency account or have several accounts then there must be account number.
amount	Y	N	10,2 / 10,(6-9)	10,2 for fiat currencies / For specific cryptocurrency length, see Crypto currency.
currency	Y	A	3	ISO 4217 / For cryptocurrencies, see Crypto currency.
order_id	Y	AN	30	Unique identification of request`
description	Y	AN	100	Transfer description.
account_by_user_country	N	N	1	If parameter provided and its value = 1, then if user is from Europe, transfer will be prepared to merchant EUR account, otherwise to merchant USD account. If merchants EUR or USD account not found – transfer will be prepared to the account provided in the receiver_account parameter.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "receiver_account": "1753154",  
   "sender": "john.doe",  
   "amount": 1.01,  
   "currency": "USD",  
   "order_id": "15_20151110080801",  
   "description": "Payment for order #15",  
   "account_by_user_country": 0,  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
code	N	N	3	See Message code.
msg	Y	AN	255	See Message code.
description	N	AN		Detailed explanation of error.
order_id	N	AN	100	UniqueID of request.
hash	N	AN	32	Unique hash code.
token_number	N	AN	10	Field should be left empty if Google 2FA is enabled.

{
   "status": "success",  
   "msg": "Transfer initialized.",  
   "order_id": "15_20151110080801",  
   "hash": "a64fb511c885f9aeff211f7bfefc5648",  
   "token_number": "48-QI"
}

External finish

Finish prepared transfer from any user to merchant account. Request user to enter his Key Code for given token_number if SMS 2FA validation is enabled. If Google 2FA is enabled, provide an empty string to token_number field and input token_code from authenticator app.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/finish_transfer

Request

Parameter	M	Type	Length	Description
receiver_account	Y	N	20	Your account ID for receiving transfer.
hash	Y	AN	32	Hash code given in InitializeTransfer success response.
token_number	Y	AN	10	token_number given in InitializeTransfer success response.
token_code	Y	N	6	User’s entered key code for given token_number.
account_by_user_country	N	N	1	If InitializeTransfer was called with this param 1, then add this param to the FinishTransfer with value 1.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "receiver_account": "1753154",  
   "hash": "5640bf0cb3e5c",  
   "token_number": "48-QI",
   "token_code": "123456",  
   "account_by_user_country": 0,  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
code	N	N	3	See Message code.
msg	Y	AN	255	See Message code.
description	N	AN		Detailed explanation of error.
transaction_id	N	N	20	Unique transaction ID.
order_id	N	AN	100	UniqueID of request.

{
   "status": "success",  
   "code": "000",  
   "msg": "Transaction successfully completed",  
   "transaction_id": "1166071",  
   "order_id": "15_20151110080801"
}

If finish transaction was failed then procedure must start again from External initialize.

Refund

Support several partial refunds.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/refund_transfer

Request

Parameter	M	Type	Length	Description
transaction_id	Y	N	20	Transaction ID which to refund.
amount	Y	N	10,2	Amount to refund.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "transaction_id": "1166071",  
   "amount": 0.50,  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
code	N	N	3	See Message code.
msg	Y	AN	255	See Message code.
description	N	AN		Detailed explanation of error.
transaction_id	N	N	20	Unique transaction ID.
amount	N	N	10,2
currency	N	A	3	ISO 4217

{
   "status": "success",  
   "code": "000",  
   "msg": "Transaction successfully completed",  
   "transaction_id": "1166071",  
   "amount": 0.50,  
   "currency": "USD"
}

Card

---

Initiate account to card transfer.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/transfer_a_to_c

Request

Parameter	M	Type	Length	Description
sender_account	Y	N	20	From account ID.
receiver_card	Y	N	20
amount	Y	N	10,2	Minimum amount 50 USD (or equivalent in other currency).
currency	Y	A	3	ISO 4217
test	Y	N	1	Is it test transaction? Possible values: 1: yes, 0: no.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "sender_account": "1753154",  
   "receiver_card": 16,  
   "amount": 60.00,  
   "currency": "USD",  
   "test": 0,  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
transaction_id	Y	A	20	Unique transaction ID.
code	Y	A		See Message code.

{
   "status": "success",  
   "msg": "Operation completed.",  
   "transaction_id": "1166071",  
   "code": "000"
}

IBAN

Initiate account to IBAN transfer.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/transfer_a_to_iban

Request

One of receiver_bank_bic, receiver_bank_routing_number or receiver_bank_clearing_system_iso_code is required for some bank providers.

Parameter	M	Type	Length	Description
sender_account	C	N	20	Account ID. Required if 'currency' field is empty.
sender_iban	Y	AN	34	Sender's bank account address - IBAN number.
sending_amount	Y	N	10,2
receiver_iban	N	AN	34	Receiver's bank account address - IBAN number. If 'receiver_iban' is provided - 'receiver_account_number' and 'receiver_sort_code' fields must be empty.
receiver_name	Y	AN	70	Alphanumeric inputs are allowed only for Business receivers.
receiver_address	N	AN	70
receiver_postal	N	AN	20
receiver_city	N	A	50	Max length is 35 for some providers.
receiver_country_code	N	A	3	ISO 3166-1
message_for_receiver	N	AN	140	For ClearBank provider - max 35 characters.
withdrawal_purpose	N	A	3	See Withdrawal purpose.
receiver_account_number	N	N	26	Required if 'receiver_iban' field is empty.
receiver_sort_code	N	AN	6	Required if 'receiver_iban' field is empty.
currency	C	A	3	ISO 4217 - Required if 'sender_account' field is empty.
request_reference	N	AN	255	This reference will be returned with Account to IBAN webhooks. Special symbols allowed: dashes.
reference	N	AN	18	This field is used for bank reference. Special symbols allowed: dashes, commas, dots, slashes.
receiver_type	N	N	1	Possible values: 1 - individual, 2 - business.
industry_id	N	N	20	Use Get Industries action to know what kind of industries exist.
client_tag	N	AN	50	This field is used to group client transactions. Special symbols allowed: dashes.
receiver_bank_name	C	AN	140	Required for some bank providers.
receiver_bank_bic	C	AN	8	Required for some bank providers.
receiver_bank_routing_number	C	AN	35	Required for some bank providers.
receiver_bank_clearing_system_iso_code	C	AN	35	Required for some bank providers.
receiver_bank_clearing_system_member_id	C	AN	35	Required if receiver_bank_clearing_system_iso_code is provided.
receiver_bank_country_code	C	AN	3 - 3	ISO 3166-1 alpha-3. Required for some bank providers.
ultimate_sender_name	N	AN	70	Ultimate sender - name.
ultimate_sender_country_code	N	AN	3 - 3	Ultimate sender - country. ISO 3166-1 alpha-3.
ultimate_sender_organization_code	N	AN	11	Ultimate sender - organization code.
ultimate_sender_birth_date	N	AN	-	Ultimate sender - birth date. Must be valid date (Y-M-D format).
ultimate_sender_birth_city	N	AN	35	Ultimate sender - birth city.
ultimate_sender_birth_country_code	N	AN	3 - 3	Ultimate sender - birth country. ISO 3166-1 alpha-3.
ultimate_sender_private_identifier	N	AN	35	Ultimate sender - private identifier.
ultimate_sender_private_issuer	N	AN	35	Ultimate sender - private issuer.
ultimate_sender_private_code	N	AN	4	Ultimate sender - private code.
ultimate_sender_private_proprietary	N	AN	35	Ultimate sender - private proprietary.
ultimate_sender_organization	N	AN	-	Ultimate sender - is organization. Available values - true/false.
ultimate_receiver_name	N	AN	70	Ultimate receiver - name.
ultimate_receiver_country_code	N	AN	3 - 3	Ultimate receiver - country. ISO 3166-1 alpha-3.
ultimate_receiver_organization_code	N	AN	11	Ultimate receiver - organization code.
ultimate_receiver_birth_date	N	AN	-	Ultimate receiver - birth date. Must be valid date (Y-M-D format).
ultimate_receiver_birth_city	N	AN	35	Ultimate receiver - birth city.
ultimate_receiver_birth_country_code	N	AN	3 - 3	Ultimate receiver - birth country. ISO 3166-1 alpha-3.
ultimate_receiver_private_identifier	N	AN	35	Ultimate receiver - private identifier.
ultimate_receiver_private_issuer	N	AN	35	Ultimate receiver - private issuer.
ultimate_receiver_private_code	N	AN	4	Ultimate receiver - private code.
ultimate_receiver_private_proprietary	N	AN	35	Ultimate receiver - private proprietary.
ultimate_receiver_organization	N	AN	-	Ultimate receiver - is organization. Available values - true/false.
schemes	N	AN	-	Payment scheme codes. (Separated by commas, if multiple). See IBAN transfer scheme
confirmation_of_payee_id	N	AN	20	Unique CoP scan ID. See Verify bank account address
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
  "sender_account": 1753154,
  "sender_iban": "GB999999999999999",
  "sending_amount": "50.55",
  "receiver_iban": "GB888888888888888",
  "receiver_name": "John Doe",
  "receiver_address": "London drift 24",
  "receiver_postal": "12345",
  "receiver_city": "London",
  "receiver_country_code": "GBR",
  "message_for_receiver": "For lunch with Queen.",
  "withdrawal_purpose": "MWP",
  "receiver_account_number": null,
  "receiver_sort_code": null,
  "request_reference": "AAA12345789",
  "reference": "RRE1324567",
  "receiver_type": 1,
  "industry_id": 10,
  "client_tag": null,
  "receiver_bank_name": "Barclays",
  "receiver_bank_bic": "HABALT22",
  "receiver_bank_routing_number": "",
  "receiver_bank_clearing_system_iso_code": "",
  "receiver_bank_clearing_system_member_id": "",
  "receiver_bank_country_code": "GBR",
  "ultimate_sender_name": "Jones Ltd.",
  "ultimate_sender_country_code": "GBR",
  "ultimate_sender_organization_code": "004",
  "ultimate_sender_birth_date": "1986-06-08",
  "ultimate_sender_birth_city": "London",
  "ultimate_sender_birth_country_code": "GBR",
  "ultimate_sender_private_identifier": "ID-2345",
  "ultimate_sender_private_issuer": "IS-12345",
  "ultimate_sender_private_code": "0004",
  "ultimate_sender_private_proprietary": "Property",
  "ultimate_sender_organization": "true",
  "ultimate_receiver_name": "Anthony Ltd.",
  "ultimate_receiver_country_code": "GBR",
  "ultimate_receiver_organization_code": "005",
  "ultimate_receiver_birth_date": "1977-08-08",
  "ultimate_receiver_birth_city": "London",
  "ultimate_receiver_birth_country_code": "GBR",
  "ultimate_receiver_private_identifier": "ID-3555",
  "ultimate_receiver_private_issuer": "IS-333",
  "ultimate_receiver_private_code": "1111",
  "ultimate_receiver_private_proprietary": "Property",
  "ultimate_receiver_organization": "true",
  "schemes": "FPS,CHAPS",
  "confirmation_of_payee_id": "123123123",
  "key": "_MERCHANT_KEY_",  
  "ts": "_TIMESTAMP_",  
  "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
transaction_id	Y	N	20	Unique transaction ID.

{
   "status": "success",  
   "msg": "Your transfer was successfully requested.",  
   "transaction_id": "1166071"
}

IBAN Inbound return

Returns a previously received inbound payment to the sender.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/transfer_iban_inbound_return

Request

One of receiver_bank_bic, receiver_bank_routing_number or receiver_bank_clearing_system_iso_code is required for some bank providers.

Parameter	M	Type	Length	Description
transaction_id	Y	N	20	Unique transaction ID.
reason	Y	AN	3	See IBAN Inbound return message codes.
receiver_name	N	AN	70
receiver_iban	N	AN	34	Not mandatory. If provided - 'receiver_account_number' and 'receiver_sort_code' fields must be empty.
receiver_account_number	N	N	26	Not mandatory. If provided - 'receiver_sort_code' field must not be empty.
receiver_sort_code	N	AN	26	Not mandatory. If provided - 'receiver_account_number' field must not be empty.
receiver_address	N	AN	70
receiver_postal	N	AN	20
receiver_city	N	AN	20
receiver_state	N	AN	20
receiver_country_code	N	AN	3	ISO 3166-1
inbound_return_purpose_code	N	AN	3	See Withdrawal purpose.
message_for_receiver	N	AN	140	For ClearBank provider - max 35 characters.
receiver_bank_name	C	AN	140	Required for some bank providers.
receiver_bank_bic	C	AN	8	Required for some bank providers.
receiver_bank_routing_number	C	AN	35	Required for some bank providers.
receiver_bank_clearing_system_iso_code	C	AN	35	Required for some bank providers.
receiver_bank_clearing_system_member_id	C	AN	35	Required if receiver_bank_clearing_system_iso_code is provided.
receiver_bank_country_code	C	AN	3 - 3	ISO 3166-1 alpha-3. Required for some bank providers.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
  "transaction_id": 1166071,
  "reason": "650",
  "receiver_name": "John Doe",
  "receiver_iban": "GB888888888888888",
  "receiver_account_number": "",
  "receiver_sort_code": "",
  "receiver_address": "Lime st. 5",
  "receiver_postal": "7004",
  "receiver_city": "New York",
  "receiver_state": "NY",
  "receiver_country_code": "USA",
  "inbound_return_purpose_code": "MWI",
  "message_for_receiver": "Return note",
  "receiver_bank_name": "Barclays",
  "receiver_bank_bic": "HABALT22",
  "receiver_bank_routing_number": "",
  "receiver_bank_clearing_system_iso_code": "",
  "receiver_bank_clearing_system_member_id": "",
  "receiver_bank_country_code": "GBR",
  "key": "_MERCHANT_KEY_",
  "ts": "_TIMESTAMP_",
  "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
transaction_id	Y	N	20	Unique transaction ID.

{
   "status": "success",  
   "msg": "Your transfer was successfully requested.",  
   "transaction_id": "1166071"
}

User

Initiate account to user transfer.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/transfer_a_to_u

Request

Parameter	M	Type	Length	Description
sender_account	Y	N	20	From account ID.
receiver	Y	AN	100	Here can be username or user email or account number where transfer money to. If submitted not account number and user did not have requested currency account or have several accounts then transfer will be made to primary account.
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "sender_account": "1753154",  
   "receiver": "user",  
   "amount": 15.00,  
   "currency": "USD",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
transaction_id	Y	N	20	Unique transaction ID.

{
   "status": "success",  
   "msg": "Operation completed.",  
   "transaction_id": "1166071"
}

Crypto

Withdraw money to crypto.

Initialize

Prepare withdraw money to crypto.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/initialize_withdraw_to_crypto

Request

Parameter	M	Type	Length	Description
account_id	Y	N	20	Here goes crypto account ID.
crypto_address	Y	AN	35	Crypto address.
receiver	Y	AN	100	Receiver.
amount	Y	N	10,2 / 10,(6-9)	10,2 for fiat currencies / For specific cryptocurrency length, see Crypto currency.
currency	Y	A	3	ISO 4217 / For cryptocurrencies, see Crypto currency.
crypto_currency	Y	A	3	See Crypto currency.
crypto_fee_rate	Y	A	3	Crypto fee rate. Value low/hi
order_id	N	AN	50	Unique identification of request.
destination_tag	C	N	10	Destinaton tag. Mandatory only for Ripple XRP crypto currency. Value from 0 to 9999999999.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "account_id": "1753154",
   "crypto_address": "1KmJT4rHiCogXyzqCTEMsXLSBDG46ypTN8",
   "receiver": "John Doe",
   "amount": "100.01",
   "currency": "EUR",
   "crypto_currency": "BTC",
   "crypto_fee_rate": "low",
   "order_id": "btc123456",
   "key": "_MERCHANT_KEY_",
   "ts": "_TIMESTAMP_",
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
code	N	N	3	See Message code.
msg	Y	AN	255	See Message code.
description	N	AN
hash	Y	AN	32	Unique hash code.
order_id	Y	AN	50
amount	Y	N	10,(6-9)	For specific cryptocurrency length, see Crypto currency.
fee_amount	Y	N	10,(6-9)	For specific cryptocurrency length, see Crypto currency.
total_amount	Y	N	10,(6-9)	For specific cryptocurrency length, see Crypto currency.
currency	Y	A	3	ISO 4217 / For cryptocurrencies, see Crypto currency.
token_number	Y	AN	10	Field should be left empty if Google 2FA is enabled.

{
   "status": "success",
   "msg": "Transaction initialized",
   "hash": "ab52ac887bea1be397da742932b4611d",
   "order_id": "btc123456",
   "amount": "0.00010000",
   "fee_amount": "0.00000090",
   "total_amount": "0.00010090",
   "currency": "BTC",
   "token_number": "19-EQ"
}

Finish

Finish prepared withdraw money to crypto. Request user to enter his Key Code for given token_number if SMS 2FA validation is enabled. If Google 2FA is enabled, provide an empty string to token_number field and input token_code from authenticator app.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/finish_withdraw_to_crypto

Request

Parameter	M	Type	Length	Description
hash	Y	AN	32	Unique hash code.
order_id	Y	AN	50
token_number	Y	AN	10
token_code	Y	N	6
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "hash": "ab52ac887bea1be397da742932b4611d",
   "order_id": "btc123456",
   "token_number": "19-EQ",
   "token_code": "123456",
   "key": "_MERCHANT_KEY_",
   "ts": "_TIMESTAMP_",
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
code	N	N	3	See Message code.
msg	Y	AN	255	See Message code.
description	N	AN
transaction_id	Y	N	20	Unique transaction ID.
currency	Y	A	3	See Crypto currency.
amount	Y	N	10,(6-9)	For specific cryptocurrency length, see Crypto currency.
crypto_address	Y	AN	35	Crypto address.

{
   "status": "success",
   "msg": "Transaction in progress",
   "transaction_id": "1166071",
   "currency": "BTC",
   "amount": "0.00010000",
   "crypto_address": "1KmJT4rHiCogXyzqCTEMsXLSBDG46ypTN8"
}

IPN Call

Parameter	M	Type	Length	Description
status	Y	AN	10	success/fail.
type	Y	AN	5
order_id	Y	AN	13
account_id	Y	N	20	Account ID.
settled_amount	Y	N	10,(6-9)	For specific cryptocurrency length, see Crypto currency.
currency	Y	A	3	See Crypto currency.
transaction_id	Y	N	20	Unique transaction ID.
crypto_address	Y	AN	35
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "status": "success",
   "type": "btc2a",
   "order_id": "btc123456",
   "account_id": "1753154",
   "settled_amount": "0.00010000",
   "currency": "BTC",
   "transaction_id": "1166071",
   "crypto_address": "1KmJT4rHiCogXyzqCTEMsXLSBDG46ypTN8",
   "key": "_MERCHANT_KEY_",
   "ts": "_TIMESTAMP_",
   "sign": "_SIGN_"
}

Card to ...

Account

Create

Initiate card to account transfer.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/transfer_c_to_a

Request

Parameter	M	Type	Length	Description
sender_card	Y	N	20	Sender card number.
expiration_date	Y	N	6	Card expiration date.
cvv	Y	N	3	CVVcode provided on the back of card.
receiver_account	Y	N	20	Receiver account ID.
amount	Y	N	10,2	Sending amount.
currency	Y	A	3	ISO 4217
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{  
   "sender_card": "16",  
   "expiration_date": "062022",  
   "cvv": "123",  
   "receiver_account": "1753154",  
   "amount": 60.00,  
   "currency": "USD",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
transaction_id	Y	A	20	Unique transaction ID.
code	Y	A		See Message code.

{
   "status": "success",  
   "msg": "Your transaction request was sent to our Bank for processing.",  
   "transaction_id": "1166071",  
   "code": "000"
}

External initialize

Prepare load money from external saved cards.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/initialize_load_from_card

Request

Parameter	M	Type	Length	Description
account_id	Y	N	20	Account ID.
credit_card_id	Y	N	20	External credit card ID could be returned by action Get user external cards list.
deposit_category	Y	N	1	See External card deposit categories.
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
merchant_website	N	AN	255	Website of the merchant.
merchant_city	N	AN	50	City of the merchant.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "account_id": "1753154",  
   "credit_card_id": "33209",  
   "deposit_category": "1",
   "amount": "77.01",  
   "currency": "EUR",
   "merchant_website": "www.your-website.com",
   "merchant_city": "Ellerslie",
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
description	N	AN
amount	Y	N	10,2
fee_amount	Y	N	10,2
total_amount	Y	N	10,2
currency	Y	A	3	ISO 4217
hash	Y	AN	32	Unique hash code.
token_number	Y	AN	10	Field should be left empty if Google 2FA is enabled.

{
   "status": "success",  
   "msg": "Transaction initialized",  
   "amount": "77.01",  
   "fee_amount": "2.23",  
   "total_amount": "79.24",  
   "currency ": "EUR",  
   "hash": "dcbcfbf7b355f3f48b5497dd1516a447",  
   "token_number": "92-AR"
}

External finish

Finish prepared load money from external saved card. Request user to enter his Key Code for given token_number if SMS 2FA validation is enabled. If Google 2FA is enabled, provide an empty string to token_number field and input token_code from authenticator app.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/finish_load_from_card

Request

Parameter	M	Type	Length	Description
hash	Y	AN	32	Unique hash code.
cvv	Y	AN	100	CVV number, must be encrypted by 3DES algorithm with 3DES.
token_number	Y	AN	10	Field should be left empty if Google 2FA is enabled.
token_code	Y	N	6
wait_response	N	N	1	Possible values: 0 - do not wait for response (webhook will be sent), 1 - wait for response (webhook response data will be returned, in case of timeout webhook will be sent).
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "hash": "dcbcfbf7b355f3f48b5497dd1516a447",  
   "cvv": "XXVfy2ZhiN4=",  
   "token_number": "92-AR",  
   "token_code": "123456",  
   "wait_response": "0",
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
s3d	Y	A	1	Possible values: 1: yes, 0: no.
md	N	AN		Unique reference for transaction.
pa_req	N	AN		Payer Authentication Request message.
description	N	AN
transaction_id	Y	N	20	Unique transaction ID.

Whenever credit card load is done and response has 3DS set to 1 - 3DS verification must be completed and 3DS data submit method executed. Example of 3DS verification form: 3DS submit form.

{
   "status": "success",
   "msg": "Transaction in progress",
   "s3d": 0,
   "transaction_id": "1166071"
}

{
   "status": "success",
   "msg": "S3D confirmation required.",
   "s3d": 1,
   "bank_link": "http://bank-url",
   "md": "15633665670206",
   "pa_req": "dGJpbWhybWM1WXA3ZytXK3ZuR3BvTGgycXBxVXNkYmRwNXA2emJqQlluK0pjSzYzZHBoNXNKS0ZxcDYxbkhmU21IV3V6Y2ZXdnM2Um5uSHJtcEtzbDl6TWo5ckN4NU9mcXN5SFpNVEtqcWFaNEwyK3kzOThiY1BXdXRpM29xK3NrYXlJdmNHamdxN2FtSTJvZ2JXOXA2VzlwcmFaanBtVm1MVEVyTFNOb3RhL3lIT0dvN0c3MllsMzBNM1ltNWl1MG1hL25LM0V5cDZZaHArWnNhSmliSXhndTdxUXdxVEFyWWFkaGEvQ2Q5S1JjS0hLcmF5VHZuMmVhT2Via3IyVXlOeDV0N0cycEoyZ29vS1p0TFdCZEkvZ2lyTE1qM1c0eTlYYzJiZkdyblY0NVkzTHdiaUd5ZEtyblcrSnRKaHJqcExBZnBlbGk2eVMxck9kcEoyTnlhNjBmNzJnaUsvR2dIYnV4TmRoc3EyNGVwNmJyY1N6cDVhdmdkeTZuNHlx"
}

{
   "type": "cc2a",  
   "account_id": "1753154",  
   "currency": "EUR",  
   "order_id": "5904623acb440",  
   "settled_amount": "77.01",  
   "status": "success",  
   "transaction_id": "1166071"
}

External unverified initialize

Prepare load money from unverified credit card.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/initialize_load_from_unverified_card

Request

Parameter	M	Type	Length	Description
account_id	Y	N	20	Account ID.
credit_card_number	Y	N	20	Credit card number must be encrypted by 3DES algorithm.
cvv	Y	N	20	CVV number, must be encrypted by 3DES algorithm.
expiration_date_month	Y	N	20	Expiration month number, must be encrypted by 3DES algorithm.
expiration_date_year	Y	N	20	Expiration year number, must be encrypted by 3DES algorithm.
name_on_card	Y	AN	32	Name of the card holder.
deposit_category	Y	N	32	See External card deposit categories
address	Y	N	50	Address of the card holder.
zip	Y	N	10	Zip code of the address.
city	Y	AN	50	City of the address.
state	Y	N	50	State of the address.
amount	Y	N	10,2
currency	Y	A	3	ISO 4217.
merchant_website	N	AN	255	Website of the merchant.
merchant_city	N	AN	50	City of the merchant.
skip_card_codes_verification	N	N	1	Defined if card codes verification is required. Possible values: 1: yes, 0: no.
wait_response	N	N	1	Possible values: 0 - do not wait for response (webhook will be sent), 1 - wait for response (webhook response data will be returned, in case of timeout webhook will be sent).
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "account_id": "1753154",  
   "credit_card_number": "IdDifEv6Qv7+QR2y9c0S7OOEmu8ajPp/",
   "cvv": "d5xIzHYC0Ds=",
   "expiration_date_month": "Nexkt7afL7E=",
   "expiration_date_year": "2RnmejSw2f8=",
   "name_on_card": "John Doe",
   "deposit_category": "1",
   "address": "14 Main Hwy",
   "zip": "1051",
   "city": "Ellerslie",
   "state": "Auckland",
   "amount": "77.01",
   "currency": "EUR",
   "merchant_website": "www.your-website.com",
   "merchant_city": "Ellerslie",
   "skip_card_codes_verification": "0",
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
hash	Y	AN	32	Unique hash code.
amount	Y	N	10,2
fee_amount	Y	N	10,2
total_amount	Y	N	10,2
currency	Y	A	3	ISO 4217
skip_card_codes_verification	Y	N	1	Defined if card codes verification is required. Possible values: 1: yes, 0: no.
s3d	N	A	1	Possible values: 1: yes, 0: no. Only when skip_card_codes_verification is provided 1.
md	N	AN		Unique reference for transaction. Only when skip_card_codes_verification is provided 1.
pa_req	N	AN		Payer Authentication Request message. Only when skip_card_codes_verification is provided 1.
description	N	AN
transaction_id	Y	N	20	Unique transaction ID.
token_number	N	AN	10	Field should be left empty if Google 2FA is enabled.

{
   "status": "success",  
   "msg": "Transaction initialized",  
   "hash": "dcbcfbf7b355f3f48b5497dd1516a447",  
   "amount": "77.01",  
   "fee_amount": "2.23",  
   "total_amount": "79.24",  
   "currency ": "EUR",
   "token_number": "92-AR",
   "skip_card_codes_verification": 0
}

{
   "status": "success",
   "msg": "Transaction in progress",
   "amount": "77.01",  
   "fee_amount": "2.23",  
   "total_amount": "79.24",  
   "currency ": "EUR",
   "s3d": 0,
   "transaction_id": "1166071",
   "skip_card_codes_verification": 1
}

{
   "status": "success",
   "msg": "S3D confirmation required.",
   "amount": "77.01",  
   "fee_amount": "2.23",  
   "total_amount": "79.24",  
   "currency ": "EUR",
   "s3d": 1,
   "bank_link": "http://bank-url",
   "md": "15633665670206",
   "pa_req": "dGJpbWhybWM1WXA3ZytXK3ZuR3BvTGgycXBxVXNkYmRwNXA2emJqQlluK0pjSzYzZHBoNXNKS0ZxcDYxbkhmU21IV3V6Y2ZXdnM2Um5uSHJtcEtzbDl6TWo5ckN4NU9mcXN5SFpNVEtqcWFaNEwyK3kzOThiY1BXdXRpM29xK3NrYXlJdmNHamdxN2FtSTJvZ2JXOXA2VzlwcmFaanBtVm1MVEVyTFNOb3RhL3lIT0dvN0c3MllsMzBNM1ltNWl1MG1hL25LM0V5cDZZaHArWnNhSmliSXhndTdxUXdxVEFyWWFkaGEvQ2Q5S1JjS0hLcmF5VHZuMmVhT2Via3IyVXlOeDV0N0cycEoyZ29vS1p0TFdCZEkvZ2lyTE1qM1c0eTlYYzJiZkdyblY0NVkzTHdiaUd5ZEtyblcrSnRKaHJqcExBZnBlbGk2eVMxck9kcEoyTnlhNjBmNzJnaUsvR2dIYnV4TmRoc3EyNGVwNmJyY1N6cDVhdmdkeTZuNHlx",
   "skip_card_codes_verification": 1
}

{
   "type": "cc2a",  
   "account_id": "1753154",  
   "currency": "EUR",  
   "order_id": "5904623acb440",  
   "settled_amount": "77.01",  
   "status": "success",  
   "transaction_id": "1166071"
}

External unverified finish

Finish prepared unverified credit card load. Request user to enter his Key Code for given token_number if SMS 2FA validation is enabled. If Google 2FA is enabled, provide an empty string to token_number field and input token_code from authenticator app.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/finish_load_from_unverified_card

Request

Parameter	M	Type	Length	Description
hash	Y	AN	32	Unique hash code.
token_number	Y	AN	10
token_code	Y	N	6
wait_response	N	N	1	Possible values: 0 - do not wait for response (webhook will be sent), 1 - wait for response (webhook response data will be returned, in case of timeout webhook will be sent).
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "hash": "dcbcfbf7b355f3f48b5497dd1516a447",  
   "token_number": "92-AR",  
   "token_code": "123456",  
   "wait_response": "0",
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
s3d	Y	A	1	Possible values: 1: yes, 0: no.
md	N	AN		Unique reference for transaction.
pa_req	N	AN		Payer Authentication Request message.
msg	Y	AN	255	See Message code.
description	N	AN
transaction_id	Y	N	20	Unique transaction ID.

Whenever credit card load is done and response has 3DS set to 1 - 3DS verification must be completed and 3DS data submit method executed. Example of 3DS verification form: 3DS submit form.

{
   "status": "success",
   "msg": "Transaction in progress",
   "s3d": 0,
   "transaction_id": "1166071"
}

{
   "status": "success",
   "msg": "S3D confirmation required.",
   "s3d": 1,
   "bank_link": "http://bank-url",
   "md": "15633665670206",
   "pa_req": "dGJpbWhybWM1WXA3ZytXK3ZuR3BvTGgycXBxVXNkYmRwNXA2emJqQlluK0pjSzYzZHBoNXNKS0ZxcDYxbkhmU21IV3V6Y2ZXdnM2Um5uSHJtcEtzbDl6TWo5ckN4NU9mcXN5SFpNVEtqcWFaNEwyK3kzOThiY1BXdXRpM29xK3NrYXlJdmNHamdxN2FtSTJvZ2JXOXA2VzlwcmFaanBtVm1MVEVyTFNOb3RhL3lIT0dvN0c3MllsMzBNM1ltNWl1MG1hL25LM0V5cDZZaHArWnNhSmliSXhndTdxUXdxVEFyWWFkaGEvQ2Q5S1JjS0hLcmF5VHZuMmVhT2Via3IyVXlOeDV0N0cycEoyZ29vS1p0TFdCZEkvZ2lyTE1qM1c0eTlYYzJiZkdyblY0NVkzTHdiaUd5ZEtyblcrSnRKaHJqcExBZnBlbGk2eVMxck9kcEoyTnlhNjBmNzJnaUsvR2dIYnV4TmRoc3EyNGVwNmJyY1N6cDVhdmdkeTZuNHlx"
}

{
   "type": "cc2a",  
   "account_id": "1753154",  
   "currency": "EUR",  
   "order_id": "5904623acb440",  
   "settled_amount": "77.01",  
   "status": "success",  
   "transaction_id": "1166071"
}

IPN Call

Parameter	M	Type	Length	Description
status	Y	AN	10	success/ fail.
type	Y	AN	4
account_id	Y	N	20	Account ID.
order_id	Y	AN	13
settled_amount	Y	N	10,2
currency	Y	A	3	ISO 4217
transaction_id	Y	N	20	Unique transaction ID.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
  "status": "success",
  "type": "cc2a",
   "account_id": "1753154",  
   "currency": "EUR",  
   "order_id": "5904623acb440",  
   "settled_amount": "77.01",  
   "transaction_id": "1166071",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

3DS data submit

Confirm credit card load with 3DS.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/s3d_data_submit

Request

Parameter	M	Type	Length	Description
hash	Y	AN	32	Unique hash code.
md	Y	AN		The unique reference for transaction.
pa_res	Y	AN		Payer Authentication Response message.
wait_response	N	N	1	Possible values: 0 - do not wait for response (webhook will be sent), 1 - wait for response (webhook response data will be returned, in case of timeout webhook will be sent).
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "hash": "dcbcfbf7b355f3f48b5497dd1516a447",
   "md": "15633665670206",
   "pa_res": "djl0L2g3Q1owZGlGck1lSXczSytwTHlIdm1XWXRMRFdwNHFCbHJXZWVLR2Ftc2JJaDZtRmVaaVp0NlM1bll6VGxxZXBsckt0cDRkN3NvRHdqNC9Rb05LOGo5ZkI3Y3F0cExhYm44WGNocWlEN2FKOHdHNk11YmUvcVphcjJjQnNmYzZsaDhlMWtwTEcwSW1vaUxTMXBaS1RscitvcUxITG5NVEhzS21ldU15LzIzK0hzSm5SMklXc3g0akRjcjZrdkllK1paaTBzTmFuaW9HV3RaNTRvWnFheHNpSHFZVjVtSm0zcExtZGpOT1dwNm1Xc3EybmgzdXlnUENQajlDZzByeVAxOEh0eXEya3RwdWZ4ZHlHcUlQdG9uekFib3k1dDcrcGxxdlp3R3g5enFXSHg3V1Nrc2JRaWFpSXRMV2xrcE9XdjZpb3NjdWN4TWV3cVo2NHpML2JmNGV3bWRIWWhhekhpTU55dnFTOGg3NWxtTFN3MXFlS2daYTFubmlo",
   "wait_response": "0",
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
transaction_id	Y	N	20	Unique transaction ID.

{
   "status": "success",
   "msg": "Transaction in progress",
   "transaction_id": "1166071"
}

{
   "type": "cc2a",  
   "account_id": "1753154",  
   "currency": "EUR",  
   "order_id": "5904623acb440",  
   "settled_amount": "77.01",  
   "status": "success",  
   "transaction_id": "1166071"
}

Card

Initiate card to card transfer.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/transfer_c_to_c

Request

Parameter	M	Type	Length	Description
sender_card	Y	N	20
receiver_card	Y	N	20
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "sender_card": "18",  
   "receiver_card": 16,  
   "amount": 1.01,  
   "currency": "USD",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
transaction_id	Y	A	20	Unique transaction ID.

{
   "status": "success",  
   "msg": "Operation completed.",  
   "transaction_id": "1166071"
}

Crypto to ...

Account

Load money from crypto.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/load_from_crypto

Request

Parameter	M	Type	Length	Description
account_id	Y	N	20	Account ID.
amount	Y	N	10,2 / 10,(6-9)	10,2 for fiat currencies / For specific cryptocurrency length, see Crypto currency.
currency	Y	A	3	ISO 4217 / For cryptocurrencies, see Crypto currency.
crypto_currency	Y	A	3	See Crypto currency.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.
order_id	Y	AN	50	Unique identification of request.

{
   "account_id": "1753154",  
   "amount": "100.01",  
   "currency": "EUR",  
   "crypto_currency": "BTC",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_",  
   "order_id": "_ORDER_ID_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
description	N	AN
funds_loads_id	Y	N	20
crypto_currency	Y	A	3	See Crypto currency.
crypto_amount	Y	N	10,(6-9)	For specific cryptocurrency length, see Crypto currency.
crypto_address	Y	AN	35	crypto_address, that you will receive from this method, could be used more than one time.
destinationTag	N	N	10	Destinaton tag. Returned only for Ripple XRP crypto currency.

{
   "status": "success",  
   "msg": "Transaction in progress",  
   "funds_loads_id": "68044",  
   "crypto_amount": "0.09791538",  
   "crypto_address": "1KmJT4rHiCogXyzqCTEMsXLSBDG46ypTN8"
}

IPN Call

Parameter	M	Type	Length	Description
status	Y	AN	10	success/fail.
type	Y	AN	4
account_id	Y	N	20
order_id	Y	AN	13
settled_amount	Y	N	10,2 / 10,(6-9)	10,2 for fiat currencies / For specific cryptocurrency length, see Crypto currency.
currency	Y	A	3	ISO 4217 / For cryptocurrencies, see Crypto currency.
transaction_id	Y	N	20	Unique transaction ID.
crypto_address	Y	AN	35
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "status": "success",
   "type": "api_btc2a",  
   "account_id": "1753154",  
   "currency": "EUR",  
   "order_id": "5902019b5f9f8",  
   "settled_amount": "100.01",    
   "transaction_id": "1166071",  
   "crypto_address": "2N9U262RUR3cG16wimwfdTxBwmxRHe5BtDv",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Account (BTC legacy)

Load money from Bitcoin. Be aware that LoadFromBitcoin is a legacy method, for new integrations please refer to 'LoadFromCrypto` method instead.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/load_from_bitcoin

Request

Parameter	M	Type	Length	Description
account_id	Y	N	20	Account ID.
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.
order_id	Y	AN	50	Unique identification of request.

{
   "account_id": "1753154",  
   "amount": "100.01",  
   "currency": "EUR",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_",  
   "order_id": "_ORDER_ID_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
description	N	AN
funds_loads_id	Y	N	20
bitcoin_amount	Y	N	10,8
bitcoin_address	Y	AN	35

{
   "status": "success",  
   "msg": "Transaction in progress",  
   "funds_loads_id": "68044",  
   "bitcoin_amount": "0.09791538",  
   "bitcoin_address": "1KmJT4rHiCogXyzqCTEMsXLSBDG46ypTN8"
}

IPN Call

Parameter	M	Type	Length	Description
status	Y	AN	10	success/fail.
type	Y	AN	4
account_id	Y	N	20	Account ID.
order_id	Y	AN	13
settled_amount	Y	N	10,2
currency	Y	A	3	ISO 4217
transaction_id	Y	N	20	Unique transaction ID.
crypto_address	Y	AN	35
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "status": "success",
   "type": "api_btc2a",  
   "account_id": "1753154",  
   "currency": "EUR",  
   "order_id": "5902019b5f9f8",  
   "settled_amount": "100.01",   
   "transaction_id": "1166071",  
   "crypto_address": "2N9U262RUR3cG16wimwfdTxBwmxRHe5BtDv",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Account (ETH legacy)

Load money from Ethereum. Be aware that LoadFromEtherium is a legacy method, for new integrations please refer to 'LoadFromCrypto` method instead.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/load_from_ethereum

Response

Parameter	M	Type	Length	Description
account_id	Y	N	20	Account ID.
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.
order_id	Y	AN	50	Unique identification of request.

{
   "account_id": "1753154",  
   "amount": "100.01",  
   "currency": "EUR",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_",  
   "order_id": "_ORDER_ID_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
description	N	AN
funds_loads_id	Y	N	11
ethereum_amount	Y	N	10,9
crypto_currency_address	Y	AN	35

{
   "status": "success",  
   "msg": "Transaction in progress",  
   "funds_loads_id": "68044",  
   "ethereum_amount": "0.09791538",  
   "crypto_currency_address": "1KmJT4rHiCogXyzqCTEMsXLSBDG46ypTN8"
}

IPN Call

Parameter	M	Type	Length	Description
status	Y	AN	10	success/fail.
type	Y	AN	4
account_id	Y	N	20	Account ID.
order_id	Y	AN	13
settled_amount	Y	N	10,2
currency	Y	A	3	ISO 4217
transaction_id	Y	N	20	Unique transaction ID.
crypto_address	Y	AN	35
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "status": "success",
   "type": "api_eth2a",  
   "account_id": "1753154",  
   "currency": "EUR",  
   "order_id": "5902019b5f9f8",  
   "settled_amount": "100.01",
   "transaction_id": "1166071",  
   "crypto_address": "2N9U262RUR3cG16wimwfdTxBwmxRHe5BtDv",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Payment request link

Create

Create a new payment request link.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/create_payment_request_link

Request

Parameter	M	Type	Length	Description
type	Y	AN	45	Value must be paypal, polipay, creditcard, bitcoin, ethereum, litecoin, ripple or bitcoincash – other types are not supported.
amount	Y	N	20
account_id	Y	N	20	Account ID.
currency	Y	A	3	ISO 4217
url_user_on_success	N	A	255	URL where user will returned after successful payment.
url_user_on_fail	N	A	255	URL where user will returned in case of failed payment.
url_api_on_success	N	A	255	URL where will be sent IPN (instant payment notification) in case of successfully completed payment.
url_api_on_fail	N	A	255	URL where will be sent IPN (instant payment notification) in case of failed or canceled payment.
no_expiration	N	N	1	Possible values*: 1 : yes 0 : no. Default value is 0.
deposit_category	N	N	1	See External card deposit categories
merchant_website	N	AN	255	Website of the merchant.
merchant_city	N	AN	50	City of the merchant.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

*Note: If the link will not have expiration date - you will be able to reuse it as many times as you wish, but please be aware that once reused, original payer reference won't be available for tracking.

{
   "type": "paypal",  
   "amount": "10.50",  
   "account_id": "1753154",  
   "currency": "EUR",
   "url_user_on_success": "https://www.myeshopexample.com/success_purchase",
   "url_user_on_fail": "https://www.myeshopexample.com/failed_purchase",  
   "url_api_on_success": "https://www.myeshopexample.com/ipn_success_purchase",  
   "url_api_on_fail": "https://www.myeshopexample.com/ipn_failed_purchase",
   "no_expiration": 0,
   "deposit_category": "1",
   "merchant_website": "www.your-website.com",
   "merchant_city": "Ellerslie",
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	N	AN	255	See Message code.
link	Y	N	20
payment_request_link_url	Y	AN	255

{
   "status": "success",  
   "link": "61415477143239919",  
   "payment_request_link_url": "https://wallet.paytriot.co.uk/en/pub/initiate-payment-paypal/r/61415477143239919"
}

IPN Call

Parameter	M	Type	Length	Description
status	Y	AN	10	success/ fail.
link_id	Y	N	20
link_status	Y	N	1	See Payment request link status.
tx_id	Y	N	20
receiving_account	Y	N	20
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
payer_first_name	Y	A	60
payer_last_name	Y	A	60
payer_email	Y	AN	100
method	Y	AN	45	E.g. paypal.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "status": "success",
   "link_id": "123456789",
   "link_status": "3",
   "tx_id": "123456",
   "receiving_account": "123456",  
   "amount": "2.00",
   "currency": "USD",
   "payer_first_name": "John",
   "payer_last_name": "Doe",
   "payer_email": "john.doe@test.loc",
   "method": "paypal",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Get

Returns a list of all given methods payment request links.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_payment_request_links

Request

Parameter	M	Type	Length	Description
type	Y	AN	45	Value must be paypal, polipay, creditcard, bitcoin, ethereum, litecoin, ripple or bitcoincash – other types are not supported.
link_id	N	N	20	This variable corresponds link variable in response.
account_id	N	N	20	Account ID.
date_created_from	N	AN	10	ISO 8601
date_created_to	N	AN	10	ISO 8601
amount_from	N	N	20
amount_to	N	N	20
currency	N	AN	3	ISO 4217
is_disabled	N	N	11
status	N	N	11	Possible values: 1: active, 2: used, 3: paid, 4: expired, 5: canceled.
page	N	N	11	If page is missing, first page is returned.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
    "type": "paypal",
    "link_id": "",
    "account_id": "",
    "date_created_from": "",
    "date_created_to": "",
    "amount_from": "",
    "amount_to": "",
    "currency": "",
    "is_disabled": "",
    "status": "",
    "page": "",
    "key": "_MERCHANT_KEY_",
    "ts": "_TIMESTAMP_",
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	N	AN	255	See Message code.
current_page	Y	N	20	Number of rows per page is 50.
links	Y	LIST
id	Y	N	20
link	Y	N	20
account_id	Y	N	20	Account ID.
url	Y	AN	255
type	Y	AN	45
date_created	Y	AN	10	ISO 8601
date_expire	Y	AN	10	ISO 8601
currency	Y	AN	3	ISO 4217
amount	Y	N	20
status	Y	N	11	Possible values: 1: active, 2: used, 3: paid, 4: expired, 5: canceled.

{
    "status": "success",  
    "current_page": "1",  
    "links": [{  
        "id": "15492858346048",  
        "link": "61415477143239919",  
        "account_id": "1753154",  
        "url": "https://wallet.paytriot.co.uk/en/pub/initiate-payment-paypal/r/61415477143239919",  
        "type": "paypal",  
        "date_created": "2019-01-17",  
        "date_expire": "2019-02-07",  
        "currency": "EUR",  
        "amount": "100.00",  
        "status": "1"
   }]
}

Wire

Load

Receive money payment request.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/receive_money_request

Request

Parameter	M	Type	Length	Description
service	Y	N	1	Possible value: 1
receiving_account	Y	N	20
amount	Y	A	10,2
currency	Y	A	3	ISO 4217
custom_order_id	N	AN	50
item_name	N	AN	100
item_description	N	AN
note	N	AN
message_to_payer	N	AN
payer_title	N	AN	5
payer_first_name	Y	AN	60
payer_middle_name	N	AN	60
payer_last_name	Y	AN	60
payer_email	Y	AN	100
payer_dob	N	AN		ISO 8601
payer_gender	Y	A	1	Possible values: F: female, M: male.
payer_mobile	Y	AN	20	E.164.
payer_address	Y	AN	50
payer_city	Y	AN	50
payer_state	N	AN	50
payer_postal	Y	AN	50
payer_country	Y	A	3	ISO 3166-1
payer_id_type	N	N	20	See User ID Type.
payer_id_number	N	AN	20
payer_id_expire	N	AN		ISO 8601
payer_id_issued_country	N	A		ISO 3166-1
payer_bank_name	N	AN	100
payer_full_name_on_bank_account	N	AN	255
payer_bank_address	N	AN	100
payer_bank_city	N	AN	100
payer_bank_iban	N	AN	34	Bank account number for countries not using the international system. IBAN max length: 34. Bank account number - min: 6, max: 26
payer_bank_swift	N	AN	11
payer_bank_country	N	A	3	ISO 3166-1
payer_correspondent_bank_name	N	AN	50
payer_correspondent_bank_swift	N	AN	50
payer_correspondent_bank_city	N	AN	100
payer_correspondent_bank_currency_code	N	AN	3
poa_filename	N	AN	255
poa_filebody	N	AN		Base64 encoded file content.
poi_filename	N	AN	255
poi_filebody	N	AN		Base64 encoded file content.
i_filename	N	AN	255
i_filebody	N	AN		Base64 encoded file content.
ipn_url	N	AN	255	URL where IPN will be sent*.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

*Note: If this parameter is empty, URL for IPN will be taken from profile settings. Whenever bank transfer is completed or canceled IPN is sent to the merchant provided URL. Merchant can setup different URL for successfully completed or failed transfer if needed. Of course same URL can be used for both cases. URL setup page can be found under profile tab API. Note that POST will be sent to the provided URL. Example of data sent: Wire transfer.

{
   "service": "1",  
   "receiving_account": "1783142",  
   "amount": "1.23",  
   "currency": "USD",  
   "custom_order_id ": "Order1234",  
   "item_name": "name",  
   "item_description": "description",
   "note": "note",  
   "message_to_payer": "messager",  
   "payer_title": "mr",  
   "payer_first_name": "John",  
   "payer_middle_name": "Ben",  
   "payer_last_name": "Doe",  
   "payer_email": "JohnDoe@test.loc",  
   "payer_dob": "1990-05-31",  
   "payer_gender": "m",  
   "payer_mobile": "+12341234532",  
   "payer_address": "9999 The Avenue",
   "payer_city": "London",  
   "payer_state": "",  
   "payer_postal": "12345",  
   "payer_country": "GBR",  
   "payer_id_type": "4",  
   "payer_id_number": "20164343432",  
   "payer_id_expire": "2016-12-12",  
   "payer_id_issued_country": "GBR",  
   "payer_bank_name": "Bank Name",
   "payer_full_name_on_bank_account": "John Doe",  
   "payer_bank_address": "9999 The Avenue",
   "payer_bank_city": "London",  
   "payer_bank_iban": "GB8888888888888888",
   "payer_bank_swift": "2342342",  
   "payer_bank_country": "GBR",  
   "payer_correspondent_bank_name": "Bank Name",
   "payer_correspondent_bank_swift": "2342342",
   "payer_correspondent_bank_city": "London",
   "payer_correspondent_bank_currency_code": "GBP",
   "poa_filename": "",
   "poa_filebody": "",
   "poi_filename": "",
   "poi_filebody": "",
   "i_filename": "",
   "i_filebody": "",
   "ipn_url ": "http://www.mysite.com/ipn_catcher",
   "key": "36d8416f2938fb64",  
   "ts": 1478704902,  
   "sign": "26aac768e19294b33c256f8c8e26b947"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255
summary	Y
account_name	Y	AN	50	Bank account address - Account name.
bank	Y	AN	100	Bank account address - Bank name.
branch	Y	AN	100	Bank account address - Bank address.
sort_code	Y	AN	100	Bank account address - Sort code.
account_number	Y	N	20	Bank account address - Account number.
iban	Y	AN	100	Bank account address - IBAN number.
bic	Y	AN	100	Bank account address - BIC code.
swift	Y	AN	100	Bank account address - SWIFT code.
beneficiary_address	Y	AN	100	Account address.
currency_id	Y	N	11
currency_code	Y	A	3	ISO 4217
reference_number	Y	AN	20	Reference number by which money load will be recognized.
url	Y	AN	255	URL where payment request can be confirmed (if in request was not auto confirm) or payment request status can be checked.
payment_request_status**	Y	N	1	Possible values: 1: created, 2: confirmed, 3: paid, 4: canceled, 5: failed.

{
   "status": "success",
   "msg": "Operation completed",
   "summary":[
      {
         "account_name": "John Doe",
         "bank": "bank name",
         "branch": "branch address",
         "sort_code": "660011",
         "account_number": "78726600",
         "iban": "GB8888888888888888",
         "bic": "SRLWWW2L",
         "swift": "SRLWWW2L",
         "beneficiary_address": "account address",
         "currency_id": "43",
         "currency_code": "EUR",
         "reference_number": "B030614-496861-010",
         "url": "https://wallet.paytriot.co.uk/en/pub/wiretransferconfirm/reference/81-81-81",
         "payment_request_status": "1"
      }
   ]

}

IPN Call

Parameter	M	Type	Length	Description
status	Y	AN	10	success/ fail.
type	Y	AN	4
status_id	Y	N	1
account_id	Y	N	20	Account ID.
reference_number	Y	AN	100
custom_order_id	Y	AN	50
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
settled_amount	Y	N	10,2
settled_currency	Y	A	3	ISO 4217
transaction_id	Y	N	20	Unique transaction ID.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "status": "success",  
   "type": "mu2m",  
   "status_id": "3",  
   "account_id": "1753154",  
   "reference_number": "P000123-000321-001",  
   "custom_order_id": "ABC123",  
   "amount": "100.00",  
   "currency": "EUR",  
   "settled_amount": "100.00",  
   "settled_currency": "EUR",  
   "transaction_id": "1166071",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Load (business)

Receive money payment request from business user.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/receive_money_request_business

Request

Parameter	M	Type	Length	Description
service	Y	N	1	Possible value: 1
receiving_account	Y	N	20
amount	Y	A	10,2
currency	Y	A	3	ISO 4217
custom_order_id	N	AN	50
item_name	N	AN	100
item_description	N	AN
note	N	AN
message_to_payer	N	AN
payer_company_name	Y	AN	60
payer_company_registration_number	Y	AN	60
payer_email	Y	AN	100
payer_mobile	Y	AN	20	E.164.
payer_address	Y	AN	50
payer_city	Y	AN	50
payer_state	N	AN	50
payer_postal	Y	AN	50
payer_country	Y	A	3	ISO 3166-1
payer_bank_name	N	AN	100
payer_full_name_on_bank_account	N	AN	255
payer_bank_address	N	AN	100
payer_bank_city	N	AN	100
payer_bank_iban	N	AN	34	Bank account number for countries not using the international system. IBAN max length: 34. Bank account number - min: 6, max: 26
payer_bank_swift	N	AN	11
payer_bank_country	N	A	3	ISO 3166-1
payer_correspondent_bank_name	N	AN	50
payer_correspondent_bank_swift	N	AN	50
payer_correspondent_bank_city	N	AN	100
payer_correspondent_bank_currency_code	N	AN	3
poa_filename	N	AN	255
poa_filebody	N	AN		Base64 encoded file content.
poi_filename	N	AN	255
poi_filebody	N	AN		Base64 encoded file content.
i_filename	N	AN	255
i_filebody	N	AN		Base64 encoded file content.
ipn_url	N	AN	255	URL where IPN will be sent*.
payer_company_category_id	N	N	20	See Business categories.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

*Note: If this parameter is empty URL for IPN will be taken from profile settings. Whenever bank transfer is completed or canceled IPN is sent to the merchant provided URL. Merchant can setup different URL for successfully completed or failed transfer if needed. Of course same URL can be used for both cases. URL setup page can be found under profile tab API. Note that POST will be sent to the provided URL. Example of data sent: Wire transfer.

{
   "service": "1",  
   "receiving_account": "1783142",  
   "amount": "1.23",  
   "currency": "USD",  
   "custom_order_id ": "Order1234",  
   "item_name": "name",  
   "item_description": "description",
   "note": "note",  
   "message_to_payer": "messager",  
   "payer_company_name": "Company name",  
   "payer_company_registration_number": "Company registration number",
   "payer_email": "business@gmail.com",  
   "payer_mobile": "+12341234532",  
   "payer_address": "payer_address",  
   "payer_city": "London",  
   "payer_state": "",  
   "payer_postal": "12345",  
   "payer_country": "GBR",  
   "payer_bank_name": "Bank Name",
   "payer_full_name_on_bank_account": "John Doe",  
   "payer_bank_address": "9999 The Avenue",
   "payer_bank_city": "London",  
   "payer_bank_iban": "GB8888888888888888",
   "payer_bank_swift": "2342342",  
   "payer_bank_country": "GBR",  
   "receiver_correspondent_bank_name": "Bank Name",  
   "receiver_correspondent_bank_swift": "2342342",  
   "receiver_correspondent_bank_city": "London",  
   "receiver_correspondent_bank_currency_code": "GBP",  
   "poa_filename": "",
   "poa_filebody": "",
   "poi_filename": "",
   "poi_filebody": "",
   "i_filename": "",
   "i_filebody": "",
   "ipn_url ": "http://www.mysite.com/ipn_catcher",
   "payer_company_category_id": null,
   "key": "36d8416f2938fb64",  
   "ts": 1478704902,  
   "sign": "26aac768e19294b33c256f8c8e26b947"
}

Response

Parameter	M	Type		Length	Description
status	Y	AN		10	success/error.
msg	Y	AN		255
summary	Y
account_name	Y	AN		50	Bank account address - Account name.
bank	Y	AN		100	Bank account address - Bank name.
branch	Y	AN		100	Bank account address - Bank address.
sort_code	Y	AN		100	Bank account address - Sort code.
account_number	Y	N		20	Bank account address - Account number.
iban	Y	AN		100	Bank account address - IBAN number.
bic	Y	AN		100	Bank account address - BIC code.
swift	Y	AN		100	Bank account address - SWIFT code.
beneficiary_address	Y	AN		100	Account address.
currency_id	Y	N		11
currency_code	Y	A		3	ISO 4217
reference_number	Y	AN		20	Reference number by which money load will be recognized.
url	Y	AN		255	URL where payment request can be confirmed (if in request was not auto confirm) or payment request status can be checked.
payment_request_status**	Y	N		1	Possible values: 1: created, 2: confirmed, 3: paid, 4: canceled, 5: failed.

{
   "status": "success",
   "msg": "Operation completed",
   "summary":[
      {
         "account_name": "John Doe",
         "bank": "Bank name",
         "branch": "Branch address",
         "sort_code": "660011",
         "account_number": "78726600",
         "iban": "GB8888888888888888",
         "bic": "SRLWWW2L",
         "swift": "SRLWWW2L",
         "beneficiary_address": "Account address",
         "currency_id": "43",
         "currency_code": "EUR",
         "reference_number": "B030614-496861-010",
         "url": "https://wallet.paytriot.co.uk/en/pub/wiretransferconfirm/reference/81-81-81",
         "payment_request_status": "1"
      }
   ]
}

IPN Call

Parameter	M	Type	Length	Description
status	Y	AN	10	success/ fail.
type	Y	AN	4
status_id	Y	N	1
account_id	Y	N	20	Account ID.
reference_number	Y	AN	100
custom_order_id	Y	AN	50
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
settled_amount	Y	N	10,2
settled_currency	Y	A	3	ISO 4217
transaction_id	Y	N	20	Unique transaction ID.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "status": "success",  
   "type": "mu2m",  
   "status_id": "3",  
   "account_id": "1753154",  
   "reference_number": "P000123-000321-001",  
   "custom_order_id": "ABC123",  
   "amount": "100.00",  
   "currency": "EUR",  
   "settled_amount": "100.00",  
   "settled_currency": "EUR",  
   "transaction_id": "1166071",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Withdraw

Send money payment request.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/bank_transfer

Request

Parameter	M	Type	Length	Description
service	Y	N	1	Possible value: 1
sending_account	Y	N	20
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
custom_order_id	N	AN	50
item_name	N	AN	100
item_description	N	AN
note	N	AN		See below*.
message_to_receiver	N	AN
receiver_title	N	AN	5
receiver_first_name	Y	AN	60
receiver_middle_name	N	AN	60
receiver_last_name	Y	AN	60
receiver_email	Y	AN	100
receiver_dob	N	AN		ISO 8601
receiver_gender	Y	A	1	Possible values: F: female, M: male.
receiver_mobile	Y	AN	20
receiver_address	Y	AN	50
receiver_city	Y	AN	50
receiver_state	N	AN	50
receiver_postal	Y	AN	50
receiver_country	Y	A	3	ISO 3166-1
receiver_id_type	N	N	2	See User ID Type.
receiver_id_number	N	AN	20
receiver_id_expire	N	AN		ISO 8601
receiver_id_issued_country	N	A		ISO 3166-1
receiver_bank_name	Y	AN	100
receiver_full_name_on_bank_account	Y	AN	255
receiver_bank_address	Y	AN	100
receiver_bank_city	Y	AN	100
receiver_bank_iban	Y	AN	34	Bank account number for countries not using the international system. IBAN max length: 34. Bank account number - min: 6, max: 26
receiver_bank_swift	Y	AN	11
receiver_bank_country	Y	A	3	ISO 3166-1
receiver_correspondent_bank_name	N	AN	50
receiver_correspondent_bank_swift	N	AN	50
receiver_correspondent_bank_city	N	AN	100
receiver_correspondent_bank_currency_code	N	AN	3
withdrawal_method_id	N	N	20	S - standard (1-5 days bank transfer out), E - express (0-2 days bank transfer out).
withdrawal_purpose	Y	A	3	See Withdrawal purpose.
poa_filename	N	AN	255
poa_filebody	N	AN		Base64 encoded file content.
poi_filename	N	AN	255
poi_filebody	N	AN		Base64 encoded file content.
i_filename	N	AN	255
i_filebody	N	AN		Base64 encoded file content.
transfer_charge_code	N	AN	3	Possible values: OUR, SHA (not SEPA regions only)
receiver_bank_sort_code	N	AN	6
receiver_bank_routing_number	N	AN	35
receiver_bank_branch_code	N	AN	6
receiver_bank_financial_system_code	N	AN	11
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "service": "1",  
   "sending_account": "1783142",  
   "amount": "1.23",  
   "currency": "USD",
   "custom_order_id": "order123",  
   "item_name": "name",  
   "item_description": "description",
   "note": "note",  
   "message_to_receiver": "messager",  
   "receiver_title": "mr",  
   "receiver_first_name": "John",  
   "receiver_middle_name": "Ben",  
   "receiver_last_name": "Doe",  
   "receiver_email": "JohnDoe@test.loc",  
   "receiver_dob": "1990-05-31",  
   "receiver_gender": "m",  
   "receiver_mobile": "12341234532",  
   "receiver_address": "9999 The Avenue",
   "receiver_city": "London",  
   "receiver_state": "",  
   "receiver_postal": "12345",  
   "receiver_country": "United Kingdom",  
   "receiver_id_type": "4",  
   "receiver_id_number": "20164343432",  
   "receiver_id_expire": "2016-12-12",  
   "receiver_id_issued_country": "GBR",  
   "receiver_bank_name": "Bank Name",
   "receiver_full_name_on_bank_account": "John Doe",  
   "receiver_bank_address": "9999 The Avenue",
   "receiver_bank_city": "London",  
   "receiver_bank_iban": "GB8888888888888888",
   "receiver_bank_country": "GBR",  
   "receiver_correspondent_bank_name": "Bank Name",  
   "receiver_correspondent_bank_swift": "2342342",  
   "receiver_correspondent_bank_city": "London",  
   "receiver_correspondent_bank_currency_code": "GBP",  
   "withdrawal_method_id": "",  
   "withdrawal_purpose": "MWP",
   "poa_filename": "",
   "poa_filebody": "",
   "poi_filename": "",
   "poi_filebody": "",
   "i_filename": "",
   "i_filebody": "",
   "transfer_charge_code": "SHA",
   "receiver_bank_sort_code": "123123",
   "receiver_bank_routing_number": "123456789",
   "receiver_bank_branch_code": "123123",
   "receiver_bank_financial_system_code": "SBIN0005943",
   "key": "36d8416f2938fb64",  
   "ts": 1478704902,  
   "sign": "26aac768e19294b33c256f8c8e26b947"
}

*Note: note parameter is mandatory when receiver_bank_country is one of the following: Costa Rica, India, South Africa, UAE (United Arab Emirates), Qatar, Israel. - Costa Rica: - Please add account number in receiver_bank_iban field. Not provided information may cause the payment delay. - Please add Receiver Bank IBAN in note field. Not provided information may cause the payment delay. - India: - Please add IFSC code and purpose in note field. Not provided information may cause the payment delay. - South Africa: - Please add purpose of the payment and clearing code in note field. Not provided information may cause the payment delay. - United Arab Emirates, Qatar, Israel: - Please add purpose of the payment in note field. Not provided information may cause the payment delay.

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255

{
   "status": "success",
   "msg": "Operation completed"
}

Withdraw (business)

Send money payment request.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/bank_transfer_business

Request

Parameter	M	Type	Length	Description
service	Y	N	1	Possible value: 1
sending_account	Y	N	20
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
custom_order_id	N	AN	50
item_name	N	AN	100
item_description	N	AN
note	N	AN		See below*.
message_to_receiver	N	AN
receiver_company_name	Y	AN	60
receiver_company_registration_number	Y	AN	60
receiver_email	Y	AN	100
receiver_mobile	Y	AN	20
receiver_address	Y	AN	50
receiver_city	Y	AN	50
receiver_state	N	AN	50
receiver_postal	Y	AN	50
receiver_country	Y	A	3	ISO 3166-1
receiver_bank_name	Y	AN	100
receiver_full_name_on_bank_account	Y	AN	255
receiver_bank_address	Y	AN	100
receiver_bank_city	Y	AN	100
receiver_bank_iban	Y	AN	34	Bank account number for countries not using the international system. IBAN max length: 34. Bank account number - min: 6, max: 26
receiver_bank_swift	Y	AN	11
receiver_bank_country	Y	A	3	ISO 3166-1
receiver_correspondent_bank_name	N	AN	50
receiver_correspondent_bank_swift	N	AN	50
receiver_correspondent_bank_city	N	AN	100
receiver_correspondent_bank_currency_code	N	AN	3
receiver_company_category_id	N	N	20	See Business categories.
withdrawal_method_id	N	N	20	S - standard (1-5 days bank transfer out), E - express (0-2 days bank transfer out).
withdrawal_purpose	Y	A	3	See Withdrawal purpose.
poa_filename	N	AN	255
poa_filebody	N	AN		Base64 encoded file content.
poi_filename	N	AN	255
poi_filebody	N	AN		Base64 encoded file content.
i_filename	N	AN	255
i_filebody	N	AN		Base64 encoded file content.
transfer_charge_code	N	AN	3	Possible values: OUR, SHA (not SEPA regions only)
receiver_bank_sort_code	N	AN	6
receiver_bank_routing_number	N	AN	35
receiver_bank_branch_code	N	AN	6
receiver_bank_financial_system_code	N	AN	11
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
  "service": "1",
  "sending_account": "1783142",
  "amount": "1.23",
  "currency": "USD",
  "custom_order_id": "order123",
  "item_name": "name",
  "item_description": "Description",
  "note": "note",
  "message_to_receiver": "messager",
  "receiver_business_name": "Company LTD",
  "receiver_business_registration_number": "LT1235544",
  "receiver_email": "JohnDoe@test.loc",
  "receiver_mobile": "12341234532",
  "receiver_address": "9999 The Avenue",
  "receiver_city": "London",
  "receiver_state": "",
  "receiver_postal": "12345",
  "receiver_country": "United Kingdom",
  "receiver_id_type": "4",
  "receiver_id_number": "20164343432",
  "receiver_id_expire": "2016-12-12",
  "receiver_id_issued_country": "GBR",
  "receiver_bank_name": "Bank Name",
  "receiver_full_name_on_bank_account": "John Doe",
  "receiver_bank_address": "9999 The Avenue",
  "receiver_bank_city": "London",
  "receiver_bank_iban": "GB8888888888888888",
  "receiver_bank_swift": "2342342",
  "receiver_bank_country": "GBR",
  "receiver_correspondent_bank_name": "Bank Name",
  "receiver_correspondent_bank_swift": "2342342",
  "receiver_correspondent_bank_city": "London",
  "receiver_correspondent_bank_currency_code": "GBP",
  "receiver_company_category_id": "123",
  "withdrawal_method_id": "",
  "withdrawal_purpose": "MWP",
  "poa_filename": "",
  "poa_filebody": "",
  "poi_filename": "",
  "poi_filebody": "",
  "i_filename": "",
  "i_filebody": "",
  "transfer_charge_code": "SHA",
  "receiver_bank_sort_code": "123123",
  "receiver_bank_routing_number": "123456789",
  "receiver_bank_branch_code": "123123",
  "receiver_bank_financial_system_code": "SBIN0005943",
  "key": "36d8416f2938fb64",
  "ts": 1478704902,
  "sign": "26aac768e19294b33c256f8c8e26b947"
}

*Note: note parameter is mandatory when receiver_bank_country is one of the following: Costa Rica, India, South Africa, UAE (United Arab Emirates), Qatar, Israel. - Costa Rica: - Please add account number in receiver_bank_iban field. Not provided information may cause the payment delay. - Please add Receiver Bank IBAN in note field. Not provided information may cause the payment delay. - India: - Please add IFSC code and purpose in note field. Not provided information may cause the payment delay. - South Africa: - Please add purpose of the payment and clearing code in note field. Not provided information may cause the payment delay. - United Arab Emirates, Qatar, Israel: - Please add purpose of the payment in note field. Not provided information may cause the payment delay.

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	Success/error.
msg	Y	AN	255

{
  "status": "success",
  "msg": "Operation completed"
}

IPN Call

Parameter	M	Type	Length	Description
status	Y	AN	10	success/ fail.
type	Y	AN	4
status_id	Y	N	1
account_id	Y	N	20	Account ID.
reference_number	Y	AN	100
custom_order_id	Y	AN	50
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
settled_amount	Y	N	10,2
settled_currency	Y	A	3	ISO 4217
transaction_id	Y	N	20	Unique transaction ID.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "status": "success",  
   "type": "mm2u",  
   "status_id": "3",  
   "account_id": "1753154",  
   "reference_number": "P000123-000321-001",  
   "custom_order_id": "ABC123",  
   "amount": "100.00",  
   "currency": "EUR",  
   "settled_amount": "100.00",  
   "settled_currency": "EUR",  
   "transaction_id": "1166071",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Whenever bank transfer is completed or canceled IPN is sent to the merchant provided URL. Merchant can setup different URL for successfully completed or failed transfer if needed. Of course same URL can be used for both cases. URL setup page can be found under profile tab API. Be aware that POST will be sent to the provided URL. Example of data sent: Wire transfer.

Wire (added bank account)

Load

Load money from external saved bank.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/load_from_bank

Request

Parameter	M	Type	Length	Description
account_id	Y	N	20	Account ID.
bank_account_id	Y	N	20
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
ipn_url	N	AN	255	URL where IPN will be sent*.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

*Note: If this parameter is empty URL for IPN will be taken from profile settings.

{
   "account_id": "1753154",  
   "bank_account_id": "9625",  
   "amount": "105.11",  
   "currency": "EUR",  
   "ipn_url": "http://www.mysite.com/ipn_catcher",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
description	N	AN
amount	Y	N	10,2
fee_amount	Y	N	10,2
total_amount	Y	N	10,2
currency	Y	A	3	ISO 4217
reference_number	Y	AN	100
account_name	Y	AN	255	Bank account address - Account name.
bank	Y	AN	100	Bank account address - Bank name.
branch	Y	AN	100	Bank account address - Bank address.
account_number	Y	N	20	Bank account address - Account number.
iban	Y	AN	40	Bank account address - IBAN number.
swift	Y	AN	11	Bank account address - SWIFT code.

{
   "status": "success",  
   "msg": "Transaction in progress",  
   "amount": "105.11",  
   "fee_amount": "0.00",  
   "total_amount": "105.11",  
   "currency": "EUR",  
   "reference_number": "UPC107817236",  
   "account_name": "John Doe",  
   "bank": "Bank name",  
   "branch": "Branch address",  
   "account_number": "78726600",  
   "iban": "GB8888888888888888",  
   "swift": "12345"
}

IPN Call

Parameter	M	Type	Length	Description
status	Y	AN	10	success/fail.
type	Y	AN	4
account_id	Y	N	20	Account ID.
reference_number	Y	AN	100
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
settled_amount	Y	N	10,2
settled_currency	Y	A	3	ISO 4217
transaction_id	Y	N	20	Unique transaction ID.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "status": "success",
   "type": "b2a",  
   "account_id": "1753154",  
   "amount": "105.11",  
   "currency": "EUR",  
   "reference_number": "UPC107817236",  
   "settled_amount": "106.00",  
   "settled_currency": "EUR",    
   "transaction_id": "1166071",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Withdraw initialize

Prepare withdraw money to an external saved bank.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/initialize_withdraw_to_bank

Request

Parameter	M	Type	Length	Description
account_id	Y	N	20	Account ID.
bank_account_id	Y	N	20
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
withdrawal_method_id	N	N	20	S - standard (1-5 days wire transfer), E - express (0-2 days).
withdrawal_purpose	Y	A	3	See Withdrawal purpose.
transfer_charge_code	N	AN	3	Possible values: OUR, SHA (not SEPA regions only)
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "account_id": "1753154",  
   "bank_account_id": "9625",  
   "amount": "19.5",  
   "currency": "EUR",  
   "withdrawal_method_id": "",  
   "withdrawal_purpose": "MWP",  
   "transfer_charge_code": "SHA",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
description	N	AN
amount	Y	N	10,2
fee_amount	Y	N	10,2
total_amount	Y	N	10,2
currency	Y	A	3	ISO 4217
reference_number	Y	AN	100
hash	Y	AN	32	Unique hash code.
token_number	Y	AN	10	Field should be left empty if Google 2FA is enabled.

{
   "status": "success",  
   "msg": "Transaction initialized",  
   "amount": "19.50",  
   "fee_amount": "0.00",  
   "total_amount": "19.50",  
   "currency ": "EUR",  
   "reference_number": "UPC203104934",  
   "hash": "ab52ac887bea1be397da742932b4611d",  
   "token_number": "19-EQ"
}

Withdraw finish

Finish prepared withdraw money to external saved bank. Request user to enter his Key Code for given token_number if SMS 2FA validation is enabled. If Google 2FA is enabled, provide an empty string to token_number field and input token_code from authenticator app.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/finish_withdraw_to_bank

Request

Parameter	M	Type	Length	Description
hash	Y	AN	32	Unique hash code.
reference_number	Y	AN	100
token_number	Y	AN	10
token_code	Y	N	6
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "hash": "ab52ac887bea1be397da742932b4611d",  
   "reference_number": "UPC203104934",  
   "token_number": "19-EQ",  
   "token_code": "123456",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
description	N	AN
transaction_id	Y	N	20	Unique transaction ID.

{
   "status": "success",  
   "msg": "Transaction in progress",  
   "transaction_id": "1166071"
}

IPN Call

Parameter	M	Type	Length	Description
status	Y	AN	10	success/fail.
type	Y	AN	4
account_id	Y	N	20	Account ID.
reference_number	Y	AN	100
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
settled_amount	Y	N	10,2
settled_currency	Y	A	3	ISO 4217
transaction_id	Y	N	20	Unique transaction ID.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "status": "success",
   "type": "a2b",  
   "account_id": "1753154",  
   "amount": "19.50",  
   "currency": "EUR",  
   "reference_number": "UPC203104934",  
   "settled_amount": "19.50",  
   "settled_currency": "EUR",    
   "transaction_id": "1166071",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

IPN call resend

Transaction call resend.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/ipn_call_resend

Request

Parameter	M	Type	Length	Description
request_reference	Y	AN	255	Transaction request reference.
type	N	A	255	If not provided - marks it as "TRANSFER". Possible values: "IBAN", "TRANSFER".
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
  "request_reference": "AAA12345789",
  "type": "TRANSFER",
  "key": "_MERCHANT_KEY_",
  "ts": "_TIMESTAMP_",
  "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	Success/error.
msg	Y	AN	255	See Message code.

{
  "status": "success",
  "msg": "Successfully initiated ipn call resend."
}

User

Approve

Approve user in Paytriot.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/approve_user

Request

Parameter	M	Type	Length	Description
username	Y	AN	100
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "username": "john.doe",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.

{
  "status": "success",
  "msg": "User approved"
}

Change address

Update users address.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/update_user_address

Request

Parameter	M	Type	Length	Description
username	Y	AN	100
country_code	N	A	3	ISO 3166-1
address_line1	N	AN	100
address_line2	N	AN	100
city	N	A	45
state	N	AN	40
postal_code	N	AN	10
billing_country_code	N	A	3	ISO 3166-1
billing_address_line1	N	AN	100
billing_address_line2	N	AN	100
billing_city	N	A	45
billing_state	N	AN	40
billing_postal_code	N	AN	10
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "username": "john.doe",  
   "country_code": "GBR",  
   "address_line1": "",  
   "address_line2": "",  
   "city": "London",  
   "state": "",  
   "postal_code": "",  
   "billing_country_code": "",  
   "billing_address_line1": "",  
   "billing_address_line2": "",  
   "billing_city": "",  
   "billing_state": "",  
   "billing_postal_code": "",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.

{
   "status": "success",  
   "msg": "Address updated"
}

Create

Create user in Paytriot.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/create_user

Request

Parameter	M	Type	Length	Description
username	Y	AN	100
email	Y	AN	100
password	Y	AN	50
first_name	Y	A	60
middle_name	N	A	60
last_name	N	A	60
gender	N	A	1	Possible values: F: female, M: male.
bday	Y	AN		ISO 8601
country	N	A	2	ISO 3166-1
address_line_1	N	AN	100
address_line_2	N	AN	100
city	N	AN	45
state	N	AN	40
post_code	N	AN	10
billing_country	N	A		ISO 3166-1
billing_address_line_1	N	AN
billing_address_line_2	N	AN
billing_city	N	A
billing_state	N	A
billing_post_code	N	AN
preferred_currency	Y	A	3	ISO 4217
phone_number	N	AN	20
phone_type	N	A	1	L : landline, M : mobile.
government_issued_id_type	N	N	2	See User ID Type.
government_issued_id_number	N	AN	20
government_issued_id_expiration_date	N	AN		ISO 8601
government_issued_id_country_of_issuance	N			ISO 3166-1
language_code	N	AN	2	ISO 639-1. Example - EN, RU, etc.
tax_country_code	N	A	3	Code of user's tax country. ISO 3166-1
citizenship_country_codes	N	A	255	User's citizenships. ISO 3166-1 imploded by ,
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

Be aware that if first_name, last_name, gender, bday, address_line_1, city, country, post_code, phone_type, phone_number, government_issued_id_type, government_issued_id_number, government_issued_id_expiration_date and government_issued_id_country_of_issuance parameters will be provided, then user profile will be completed.

{
   "username": "john.doe",  
   "email": "john.doe@test.com",  
   "password": "password",  
   "first_name": "John",  
   "middle_name": "",  
   "last_name": "Doe",  
   "gender": "M",  
   "bday": "1981-11-28",  
   "country": "GBR",  
   "address_line_1": "",  
   "address_line_2": "",  
   "city": "London",  
   "state": "",  
   "post_code": "",  
   "billing_country": "",  
   "billing_address_line_1": "",  
   "billing_address_line_2": "",  
   "billing_city": "",  
   "billing_state": "",  
   "billing_post_code": "",  
   "preferred_currency": "GBP",  
   "phone_number": "+4432611151",  
   "phone_type": "M",  
   "government_issued_id_type": "1",  
   "government_issued_id_number": "123456",  
   "government_issued_id_expiration_date": "2022-08-08",  
   "government_issued_id_country_of_issuance": "GBR",  
   "language_code": "RU",
   "tax_country_code": "LTU", 
   "citizenship_country_codes": "LTU,GBR",
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"  
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
users_id	Y	N	20

{
   "status": "success",  
   "msg": "Account Created Successfully",
   "users_id": 220
}

Create merchant

Create merchant in Paytriot.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/create_merchant

Request

Parameter	M	Type	Length	Description
username	Y	AN	20
password	Y	AN	50	Password must be encrypted by 3DES algorithm.
company_name	Y	AN	200
email	Y	AN	100
currency	Y	A	3	ISO 4217
contact_first_name	Y	AS	60
contact_last_name	Y	AS	60
directors	N	AS		Comma separated values.
shareholders	N	AS		Comma separated values.
beneficial_owners	N	AS		Comma separated values.
website	Y	AN		Comma separated values.
phone_type	Y	A	1	L - for landline, M - for mobile.
phone	Y	AN	15	Phone number prefixed with +
country	Y	A	3	ISO 3166-1 Alpha-3 code
address_1	Y	AN	100
address_2	N	AN	100
city	Y	AN	45
zip	Y	AN	40
business_sectors	Y	AN	100	Numbers separated with | delimiter as a string.
is_private_company	N	N		1 - if private, 0 - otherwise.
comment	N	AN	200
vat_number	N	AN	20
language_code	N	AN	2	ISO 639-1. Example - EN, RU, etc.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "username": "john.doe",
   "password": "xLSNBdXLjYXKyIWv+I3woQ==",
   "company_name": "Example Company Ltd.",
   "email": "john.doe@test.com",
   "currency": "GBP",
   "contact_first_name": "John",
   "contact_last_name": "Doe",
   "directors": "Alex Doe",
   "shareholders": "Alex Doe, John Doe",
   "beneficial_owners": "Tracy Doe",
   "website": "https://example.com",
   "phone_type": "M",
   "phone": "+4432611151",
   "country": "GBR",
   "address_1": "Super str 115",
   "address_2": "",
   "city": "London",
   "zip": "1051",
   "business_sectors": "1|2|3",
   "is_private_company": "1",
   "comment": "",
   "vat_number": "GB4654128975",
   "language_code": "RU",
   "key": "_MERCHANT_KEY_",
   "ts": "_TIMESTAMP_",
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
users_id	Y	N	20
msg	Y	AN	255	See Message code.

{
  "status": "success",
  "msg": "Merchant user successfully created",
  "user_id": 15623681459208,
  "account_id": 1753154,
  "account_currency_id": "144",
  "crypto_accounts": {
    "215": 7149758,
    "216": 7149767,
    "217": 7149769,
    "218": 7149774,
    "219": 7149776
  },
  "companies_id": 15623364681156
}

Get

Get all merchants users list.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_users

Request

Parameter	M	Type	Length	Description
date_from	N	AN	10	ISO 8601
date_to	N	AN	10	ISO 8601
from_id	N	N	20	Will return users list with higher ID than defined (max 100).
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "date_from": "2015-06-01",  
   "date_to": "2015-06-15",  
   "from_id": 100,
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg_code	Y	AN	3	See Message code.
msg	Y	AN	255	See Message code.
filters	N	LIST		Will return used filters in request.
results_count	Y	N		Total count of filtered users.
users	Y	LIST		List of all merchant users.
id	Y	N	20
username	Y	AN	100
first_name	N	A	60
middle_name	N	A	60
last_name	N	A	60
status	Y	A	1	Possible values: D: deleted, I: inactive, B: blocked, A: approved, C: completed, R: registered.
date_created	Y	AN	10	ISO 8601
date_completed	Y	AN	10	ISO 8601, date when user profile is completed, if not there will be null.

{
   "status": "success",  
   "msg": "Success",
   "filters":{  
      "date_from": "2015-06-01",  
      "date_to": "2015-06-15",  
      "from_id": 100  
    },
   "results_count": 1,  
   "users":[    
      {    
         "id": "220",  
         "username": "john.doe",  
         "first_name": "John",  
         "middle_name": "",  
         "last_name": "Doe",
         "status": "R",  
         "date_created": "2015-06-06",  
         "date_completed": "2015-06-16"  
      }  
   ]
}

Update user contact details

Update user contact details.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/update_user_contact_details

Request

Parameter	M	Type	Length	Description
username	Y	AN	20
email	N	AN	100	Either email or phone is required
phone_type	N	A	1	L - for landline, M - for mobile. Required when phone is provided
phone	N	AN	15	Phone number prefixed with +. Either email or phone is required
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "username": "john.doe",
   "email": "john.doe@test.com",
   "phone_type": "M",
   "phone": "+4198488137",
   "key": "_MERCHANT_KEY_",
   "ts": "_TIMESTAMP_",
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
code	N	N	3	See Message code.
msg	Y	AN	255	See Message code.
description	N	AN		Detailed explanation of error.

{
   "status": "success",  
   "code": "000",  
   "msg": "User contact details successfully updated"  
}

Get account

Get all users accounts by username.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_user_accounts

Request

Parameter	M	Type	Length	Description
username	Y	AN	100
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "username": "john.doe",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
accounts	Y	LIST
id	Y	N	20
is_primary	Y	N	1	Possible values: 1: yes, 0: no.
balance	N	N	10,2
currency	Y	A	3	ISO 4217
account_type	Y	A	10	Possible values: 0: personal, 1: business, 2: inventory, 3: reserve.
status_code	Y	N	1
status	Y	A	10
is_valid_for_payment_request_link	Y	N	1	Possible values: 1: yes, 0: no.

{
   "status": "success",  
   "msg": "Success",  
   "accounts":[    
      {    
         "id": "1753298",  
         "is_primary": "1",  
         "balance": "0.00",  
         "currency": "USD",  
         "account_type": "1",  
         "status_code": "1",  
         "status": "Normal",
         "is_valid_for_payment_request_link": "1"  
      }  
   ]
}

Get address

Get user addresses by username.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_user_address

Request

Parameter	M	Type	Length	Description
username	Y	AN	100
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "username": "john.doe",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
address	Y
address_line1	N	AN	100
address_line2	N	AN	100
city	N	A	45
state	N	AN	40
postal_code	N	AN	10
country_code	N	A	3	ISO 3166-1
country	N	A	200
billing_address_line1	N	AN	100
billing_address_line2	N	AN	100
billing_city	N	A	45
billing_state	N	AN	40
billing_postal_code	N	AN	10
billing_country_code	N	A	200	ISO 3166-1
billing_country	N	A	200

{
   "status": "success",  
   "msg": "Success",  
   "address":{    
      "address_line1": "Street name 1",  
      "address_line2": "",  
      "city": "London",  
      "state": "State",  
      "postal_code": "12345",  
      "country_code": "GBR",  
      "country": "United Kingdom",  
      "billing_address_line1": "",  
      "billing_address_line2": "",  
      "billing_city": "",  
      "billing_state": "",  
      "billing_postal_code": "",  
      "billing_country_code": "",  
      "billing_country": ""  
   }
}

Get business categories

Get available business categories

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_business_categories

Request

Parameter	M	Type	Length	Description
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "key": "_MERCHANT_KEY_",
   "ts": "_TIMESTAMP_",
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
categories	Y	AN		JSON object holding available business categories

{
   "categories": {
      "15090202361788": "Adult entertainment",
      "15257886102166": "Advertising",
      "15305202234576": "Affiliate marketing",
      "15088400328253": "Assets Management",
      "15488570840664": "Betting"
   }
}

Get card

Get all users cards.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_user_cards

Request

Parameter	M	Type	Length	Description
username	Y	AN	100
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "username": "john.doe",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
cards	Y	LIST
id	Y	LIST
id	Y	N	20
status	Y	A	1	Possible values: A: activated, N: not activated, B: blocked, S: suspended, T: admin suspend (temporary blocked), E: expired.
accounts	Y	LIST
currency	Y	LIST
account	Y	N	20
currency	Y	A	3	ISO 4217
card_balance	N	N	10,2

{
   "status": "success",
   "msg": "Success",
   "cards":{
      "296":{
         "id": "296",
         "status": "A",
         "accounts":{
            "USD":{
               "account": "1753792",
               "currency": "USD",
               "card_balance": "7368.07"
            },
            "EUR":{
               "account": "1777364",
               "currency": "EUR",
               "card_balance": "1354.07"
            }
         }
      },
      "388":{
         "id": "388",
         "status": "A",
         "accounts":{
            "EUR":{
               "account": "1777364",
               "currency": "EUR",
               "card_balance": "4897.57"
            }
         }
      }
   }
}

Get detail

Get user detail by username.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_user_details

Request

Parameter	M	Type	Length	Description
username	Y	AN	100
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "username": "john.doe",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
user_details	Y
id	N	N	20
username	N	AN	100
user_permission_group	N	AN	100
date_register	N	AN	10	ISO 8601
first_name	N	AN	60
middle_name	N	AN	60
last_name	N	AN	60
date_Of_birth	N	AN	100
merchant_sponsor	N	AN	100
gender	N	A	1
address	N	AN	100
address_2	N	AN	100
city	N	AN	45
state	N	AN	40
postal_code	N	AN	100
country	N	AN	100
home_phone	N	AN	100
work_phone	N	AN	100
cell_phone	N	AN	100
email	N	AN	100
billing_address	N	AN	100
billing_address_2	N	AN	100
billing_city	N	AN	100
billing_state	N	AN	100
billing_postal_code	N	AN	100
billing_country	N	AN	100

{
   "status": "success",  
   "msg": "Success",  
   "user_details":{    
      "id": "1",  
      "username": "username",  
      "user_permission_group": "merchant",  
      "date_register": "2015-04-01",  
      "timezone": "Europe/London",  
      "first_name": "John",  
      "middle_name": "",  
      "last_name": "Doe",  
      "date_of_birth": "1980-01-01",  
      "merchant_sponsor": "",  
      "gender": "M",  
      "address": "",  
      "address_2": "",  
      "city": "",  
      "state": "",  
      "postal_code": "",  
      "country": "United Kingdom",  
      "home_phone": "",  
      "work_phone": "",  
      "cell_phone": "",  
      "email": "john.doe@test.loc",  
      "billing_address": "",  
      "billing_address_2": "",  
      "billing_city": "",  
      "billing_state": "",  
      "billing_postal_code": "",  
      "billing_country": "United Kingdom"  
   }
}

Get email

Get user email by username.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_user_email

Request

Parameter	M	Type	Length	Description
username	Y	AN	100
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "username": "john.doe",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
email	Y	AN	100

{
   "status": "success",  
   "msg": "Success",  
   "email": "john.doe@test.com"
}

Get transaction limit

Get limits for account transactions.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_transaction_limits

Request

Parameter	M	Type	Length	Description
account_id	Y	N	20	Account ID.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "account_id": "1753154",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
limits	Y	LIST
type_key	Y	LIST
resource_calc	Y	LIST
	Y	LIST
description	Y	A	255
value	Y	AN	255
currency	Y	A	3	ISO 4217
period	Y	AN	255

{
   "status": "success",  
   "msg": "Success",  
   "limits":{  
      "AB2C":{  
         "MAX_VALUE":[  
            {  
               "description": "MAX amount",  
               "value": "1555",  
               "currency": "EUR"  
            }  
         ],  
         "TX_AMOUNT_SUM":[  
            {  
               "description": "Transactions amounts sum per 1 hours",  
               "value": "200",  
               "currency": "EUR",  
               "period": "1 hour"  
            }  
         ]  
      },  
      "CC2AB":{  
         "TX_COUNT":[  
            {  
               "description": "Failed transactions count per card per 24 hours",  
               "value": "5",  
               "period": "24 hour"  
            }  
         ]  
      }  
   }
}

KYC

Add

Upload user’s KYC files. Acceptable file types: .jpg, .png, .pdf, .doc.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/update_user_kyc

Request

Parameter	M	Type	Length	Description
username	Y	AN	100
filename	Y	AN	50	Must be with file extension.
doctype	Y	N	2	See KYC document Type.
organizations_name	N	AN	100	Mandatory in some cases. See KYC document Type.
file_body	Y	AN	2MB	Base64 encoded file content.
notification_url	N	AN	255	If provided - URL where notifications will be pushed when KYC status will be changed*.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

*Note: POST will be made to the provided URL address. e.g. http://www.mydomain.com/kyc_notifications. See KYC notification catcher.

{
   "username": "john.doe",  
   "filename": "example_passport.jpg",  
   "doctype": 1,  
   "organization_name": "",  
   "file_body": "_BASE_64_ENCODED_FILE_",
   "notification_url": "http://www.mydomain.com/kyc_notifications",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
id	Y	N	20	Updated KYC document ID.

{
   "status": "success",  
   "msg": "Kyc updated.",
   "id": "81815"
}

Get status

Get users KYC files status.

URL
https://api.paytriot.co.uk/api/merchant/v/1.0/function/get_user_kyc_status

Request

Parameter	M	Type	Length	Description
username	Y	AN	100
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "username": "john.doe",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	AN	10	success/error.
msg	Y	AN	255	See Message code.
kyc_statuses	Y	LIST
id	Y	N	20
date_provided	Y	AN	10	ISO 8601
type_id	Y	N	20	See KYC document Type.
type	Y	A	20
status_code	Y	N	1	Possible values: 2: approved, 3: rejected, 4: pending, 6: requested, 8: under review.
status_reason	Y	AN	500	Reason for status
status	Y	A	20

{
   "status": "success",  
   "msg": "Success",  
   "kyc_statuses":[    
      {    
         "id": "29",  
         "date_provided": "2015-01-30",  
         "type_id": "1",  
         "type": "Utility Bill",
         "status_code": "2",
         "status": "Requested"  
      }  
   ]
}

Webhooks

Card

Card issuing completed

Notification sent upon successfully issuing a card.

URL
%YOUR_REGISTERED_MERCHANT_URL%/card-issue-completed

Request

Parameter	M	Type	Length	Description
card_id	Y	N	20	Card ID.
card_request_id	Y	N	20	Card request ID.
currency	Y	AN	-	A list of currencies the card supports in ISO 4217 alphabetic code. Example: ["EUR, USD"].
card_number	N	AN	-	Card number in full. Must be encrypted using the 3DES algorithm with a 3DES key – provided by Paytriot.
cvv	N	AN	-	Card verification code (CVV). Must be encrypted using the 3DES algorithm with a 3DES key – provided by Paytriot.
name_on_card	N	AN	30	Name on the card.
expiry_month	N	N	2	Card expiry month. Format: MM.
expiry_year	N	N	4	Card expiry year. Format: YY or YYYY.
first_name	N	A	60	Cardholder's first name.
last_name	N	A	60	Cardholder's last name.
email	N	A	50	Cardholder's email address.
mobile	N	AN	20	Cardholder's phone number.
accounts_ids	N	AN	-	A list of account IDs. Example: "[1753154, 1753155]".
user_id	N	N	20	User ID.
username	N	AN	100	Username.
acs_password	N	AN	-	Card ACS password. Must be encrypted using the 3DES algorithm with a 3DES key – provided by Paytriot.
key	N	AN	16	Merchant API Key – provided by Paytriot.
ts	N	N	10	Request timestamp.
sign	N	AN	32	See Sign generation.

{
    "card_id": "1353",
    "card_request_id": "1353",
    "currency": "[\"GBP\"]",
    "card_number": "+auQjcJ8sh6xiArXQpsyYA==",
    "cvv": "qcsc0SC\\/V\\/A=",
    "name_on_card": "John Doe",
    "expiry_month": "12",
    "expiry_year": "15",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@test.loc",
    "mobile": "38741220012",
    "accounts_ids": "[1753154, 1753155]",
    "user_id": 1000001,
    "username": "johndoe",
    "acs_password": "7H+Ft5z1Zq6\/uX52u2254A==",
    "key": "_MERCHANT_KEY_",  
    "ts": "_TIMESTAMP_",  
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
  "status": "OK"
}

Card issuing failed

Notification sent upon failing to issue a card.

URL
%YOUR_REGISTERED_MERCHANT_URL%/card-issue-failed

Request

Parameter	M	Type	Length	Description
card_request_id	Y	N	20	Card request ID.
error_message	Y	AN	255	Error message.
key	N	AN	16	Merchant API Key – provided by Paytriot.
ts	N	N	10	Request timestamp.
sign	N	AN	32	See Sign generation.

{
    "card_request_id": "1353",
    "error_message": "Card program is not set up",
    "key": "_MERCHANT_KEY_",  
    "ts": "_TIMESTAMP_",  
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
  "status": "OK"
}

Card transaction

Notification sent upon any transactional event related to the card.

URL
%YOUR_REGISTERED_MERCHANT_URL%/card-transaction

Request

Parameter	M	Type	Length	Description
transaction_id	Y	N	-	Transaction ID.
microfilm_ref_number	N	AN	-	Microfilm reference number.
card_id	N	N	-	Card ID.
mcc_code	N	N	1-4	DE18. Merchant category code.
country_code	N	A	3	ISO 3166-1
date_time	N	A	-	Unix timestamp.
amount	N	N	-	Amount related to the transaction.
currency	N	A	3	Transaction currency in ISO 4217 alphabetic code.
details	N	A	-	Details about the transaction.
tx_status	N	A	-	Status of the transaction. See Card transaction status.
is_withdraw	N	B	-	True if the transaction is a withdrawal; otherwise false.
tx_type	N	N	-	Type of card transaction. See Card transaction types.
date_valid_until	N	A	-	Validity date for the transaction.
proc_code	N	A	-	Processing code for the transaction.
txn_amount	N	N	-	Amount of the transaction.
txn_currency	N	A	3	Currency of the transaction in ISO 4217 alphabetic code.
fee_amount	N	N	-	Calculated fee for transaction according to program settings.
fee_currency	N	A	3	Fee currency in ISO 4217 alphabetic code.
auth_code	N	AN	6	DE38 provided when received by Scheme.
entry_mode_type	N	N	-	Entry mode type for the transaction. See Entry mode types.
is_contactless	N	B	-	True if the transaction was made using contactless; otherwise false.
is_reversal	N	B	-	True if the transaction is a reversal; otherwise false.
is_incremental	N	B	-	True if the transaction is incremental; otherwise false.
dispute_id	N	N	-	Dispute ID. Provided if the dispute was created.
dispute_status	N	N	-	Dispute status. Provided if the dispute was created. See Dispute status.
key	N	AN	16	Merchant API Key – provided by Paytriot.
ts	N	N	10	Request timestamp.
sign	N	AN	32	See Sign generation.

{
  "transaction_id": 89326963619323053,
  "microfilm_ref_number": "2w9vv8yfPK42AnyeN4lq",
  "card_id": 85677384889485520,
  "mcc_code": 3412,
  "country_code": "GBR",
  "date_time": "2023-09-04 12:53:08",
  "amount": 590,
  "currency": "EUR",
  "details": "GtwMerchant London GBR",
  "tx_status": 3,
  "is_withdraw": true,
  "tx_type": 2,
  "date_valid_until": "1693907588",
  "proc_code": "000000",
  "txn_amount": "500",
  "txn_currency": "EUR",
  "fee_amount": "0",
  "fee_currency": "EUR",
  "auth_code": "737895",
  "entry_mode_type": 3,
  "is_contactless": false,
  "is_reversal": false,
  "is_incremental": false,
  "dispute_id": null,
  "dispute_status": null,
  "key": "_MERCHANT_KEY_",
  "ts": "_TIMESTAMP_",
  "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
  "status": "OK"
}

Direct debit mandate

Created

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/direct-debit-mandate-created	POST

Request

Parameter	M	Type	Length	Description
mandate_id	Y	N	20
mandate_status	Y	N	20	See Mandate statuses.
mandate_type	Y	N	20	See Mandate types.
iban_id	Y	N	20	IBAN ID.
iban	Y	AN	34	Bank account address - IBAN number.
originator_id	Y	N	20
originator_name	Y	AN	255
originator_service_user_number	Y	N	6	Unique reference, which identifies originator
originator_iban	Y	AN	34	Originator's bank account address - IBAN number
originator_account_name	Y	A	40	Originator's bank account address - Account name
originator_account_number	N	N	26	Originator's bank account address - Account number
originator_sort_code	N	AN	6	Originator's bank account address - Sort code
reference	Y	AN	18
request_reference	N	AN	255	Request reference that has been provided in Mandate creation call.
created_at	Y	AN	25	ISO 8601
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
    "mandate_id": "12345678910",
    "mandate_status":1,
    "mandate_type":2,
    "iban_id": "12345678910",
    "iban": "GB8898887977777777",
    "originator_id": "12345678910",
    "originator_name": "Originator EU",
    "originator_service_user_number": "123456",
    "originator_iban": null,
    "originator_account_name": "Originator EU",
    "originator_account_number": "78726600",
    "originator_sort_code": "660011",
    "reference": "GRE547877",
    "request_reference": null,
    "created_at": "2020-01-20T06:18:23+00:00",
    "key": "_MERCHANT_KEY_",
    "ts": "_TIMESTAMP_",
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Canceled

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/direct-debit-mandate-canceled	POST

Request

Parameter	M	Type	Length	Description
mandate_id	Y	N	20
mandate_status	Y	N	20	See Mandate statuses.
mandate_type	Y	N	20	See Mandate types.
iban_id	Y	N	20	IBAN ID.
iban	Y	AN	34	Bank account address - IBAN number.
originator_id	Y	N	20
originator_name	Y	AN	255
originator_service_user_number	Y	N	6	Unique reference, which identifies originator
originator_iban	Y	AN	34	Originator's bank account address - IBAN number
originator_account_name	Y	A	40	Originator's bank account address - Account name
originator_account_number	N	N	26	Originator's bank account address - Account number
originator_sort_code	N	AN	6	Originator's bank account address - Sort code
reference	Y	AN	18
request_reference	N	AN	255	Request reference that has been provided in Mandate creation call.
created_at	Y	AN	25	ISO 8601
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
    "mandate_id": "12345678910",
    "mandate_status":1,
    "mandate_type":2,
    "iban_id": "12345678910",
    "iban": "GB8898887977777777",
    "originator_id": "12345678910",
    "originator_name": "Originator EU",
    "originator_service_user_number": "123456",
    "originator_iban": null,
    "originator_account_name": "Originator EU",
    "originator_account_number": "78726600",
    "originator_sort_code": "660011",
    "reference": "GRE547877",
    "request_reference": null,
    "created_at": "2020-01-20T06:18:23+00:00",
    "key": "_MERCHANT_KEY_",
    "ts": "_TIMESTAMP_",
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Originator changed

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/direct-debit-mandate-originator-changed	POST

Request

Parameter	M	Type	Length	Description
mandate_id	Y	N	20
new_originator_id	Y	N	20
new_originator_name	Y	AN	255
new_originator_service_user_number	Y	N	6	Unique reference, which identifies originator
old_originator_id	Y	N	20
old_originator_name	Y	AN	255
old_originator_service_user_number	Y	N	6	Unique reference, which identifies originator
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
    "mandate_id": "12345678910",
    "new_originator_id": "12345678910",
    "new_originator_name": "Originator EU",
    "new_originator_service_user_number": "123456",
    "old_originator_id": "342523452345",
    "old_originator_name": "Originator EU",
    "old_originator_service_user_number": "123457",
    "key": "_MERCHANT_KEY_",
    "ts": "_TIMESTAMP_",
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Activated

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/direct-debit-mandate-activated	POST

Request

Parameter	M	Type	Length	Description
mandate_id	Y	N	20
request_reference	N	AN	255	Request reference that has been provided in Mandate creation call.
activated_at	Y	AN	25	ISO 8601
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
    "mandate_id": "12345678910",
    "request_reference": null,
    "activated_at": "2020-01-20T06:18:23+00:00",
    "key": "_MERCHANT_KEY_",
    "ts": "_TIMESTAMP_",
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Migrated

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/direct-debit-mandate-migrated	POST

Request

Parameter	M	Type	Length	Description
mandate_id	Y	N	20
request_reference	N	AN	255	Request reference that has been provided in Mandate creation call.
migrated_at	Y	AN	25	ISO 8601
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
    "mandate_id": "12345678910",
    "request_reference": null,
    "migrated_at": "2020-01-20T06:18:23+00:00",
    "key": "_MERCHANT_KEY_",
    "ts": "_TIMESTAMP_",
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Activation failed

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/direct-debit-mandate-activation-failed	POST

Request

Parameter	M	Type	Length	Description
mandate_id	Y	N	20
request_reference	N	AN	255	Request reference that has been provided in Mandate creation call.
failed_at	Y	AN	25	ISO 8601
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
    "mandate_id": "12345678910",
    "request_reference": null,
    "failed_at": "2020-01-20T06:18:23+00:00",
    "key": "_MERCHANT_KEY_",
    "ts": "_TIMESTAMP_",
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Rejection failed

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/direct-debit-mandate-rejection-failed	POST

Request

Parameter	M	Type	Length	Description
mandate_id	Y	N	20
request_reference	N	AN	255	Request reference that has been provided in Mandate creation call.
failed_at	Y	AN	25	ISO 8601
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
    "mandate_id": "12345678910",
    "request_reference": null,
    "failed_at": "2020-01-20T06:18:23+00:00",
    "key": "_MERCHANT_KEY_",
    "ts": "_TIMESTAMP_",
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Cancelation failed

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/direct-debit-mandate-cancelation-failed	POST

Request

Parameter	M	Type	Length	Description
mandate_id	Y	N	20
request_reference	N	AN	255	Request reference that has been provided in Mandate creation call.
failed_at	Y	AN	25	ISO 8601
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
    "mandate_id": "12345678910",
    "request_reference": null,
    "failed_at": "2020-01-20T06:18:23+00:00",
    "key": "_MERCHANT_KEY_",
    "ts": "_TIMESTAMP_",
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

IBAN

Create

Completed

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/iban-create-completed	POST

Request

Parameter	M	Type	Length	Description
iban_request_id	Y	N	20
iban_request_status	Y	N	20	See IBAN request status
iban_accounts	Y	AN		Bank account address - IBAN accounts JSON.
account_id	Y	N	20
currency_code	Y	A	3	ISO 4217
iban_id	Y	N	20
iban	Y	AN	34	Bank account address - IBAN number
account_name	Y	A	40	Bank account address - Account name
account_number	Y	N	26	Bank account address - Account number
sort_code	Y	N	6	Bank account address - Sort code.
bic	Y	AN	12	Bank account address - BIC code.
inbound_enabled	Y	N	1	Bank account address inbound status
outbound_enabled	Y	N	1	Bank account address outbound status
iban_bank_provider_id	Y	N	20	See IBAN bank providers
request_reference	N	AN	255	Request reference that has been provided in IBAN create call.
industry_id	N	N	20	Use Get Industries action to know what kind of industries exist. Use 0 value to remove industry.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
    "iban_request_id": "15718270609474",
    "iban_request_status": "5",
    "iban_accounts": "[{\"account_id\":9150679,\"currency_code\":\"EUR\",\"status_id\":1,\"inbound_enabled\":true,\"outbound_enabled\":true},{\"account_id\":9153725,\"currency_code\":\"CAD\",\"status_id\":1,\"inbound_enabled\":true,\"outbound_enabled\":true},{\"account_id\":9153773,\"currency_code\":\"USD\",\"status_id\":1,\"inbound_enabled\":true,\"outbound_enabled\":true}]",
    "account_id": "1753154",
    "currency_code": "GBP",
    "iban_id": 12345678,
    "iban": "GB8888888888888",
    "account_name": "Joe Noe",
    "account_number": "78726600",
    "sort_code": "660011",
    "bic": "SRLWWW2L",
    "inbound_enabled": "1",
    "outbound_enabled": "1",
    "iban_bank_provider_id": "1",
    "request_reference": "123456789",
    "key": "_MERCHANT_KEY_",
    "ts": "_TIMESTAMP_",
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Failed

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/iban-create-failed	POST

Request

Parameter	M	Type	Length	Description
iban_request_id	Y	N	20
iban_request_status	Y	N	20	See IBAN request status
iban_accounts	Y	AN		Bank account address - IBAN accounts JSON.
account_id	Y	N	20	Account ID.
currency_code	Y	A	3	ISO 4217
request_reference	N	AN	255	Request reference that has been provided in IBAN create call.
error_message	N	AN	255	Error message why IBAN failed to be created.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
    "iban_request_id": "15718270609474",
    "iban_request_status": "4",
    "iban_accounts": "[{\"account_id\":9150679,\"currency_code\":\"EUR\",\"status_id\":1,\"inbound_enabled\":true,\"outbound_enabled\":true},{\"account_id\":9153725,\"currency_code\":\"CAD\",\"status_id\":1,\"inbound_enabled\":true,\"outbound_enabled\":true},{\"account_id\":9153773,\"currency_code\":\"USD\",\"status_id\":1,\"inbound_enabled\":true,\"outbound_enabled\":true}]",
    "account_id": "1753154",
    "currency_code": "GBP",
    "request_reference": "123456789",
    "error_message": "Field `bank_account_holder_state` is invalid.",
    "key": "_MERCHANT_KEY_",
    "ts": "_TIMESTAMP_",
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Status change

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/iban-status-change	POST

Request

Parameter	M	Type	Length	Description
iban_id	Y	N	20	IBAN ID.
iban	Y	AN	34	Bank account address - IBAN number
status_id	Y	N	20	See IBAN status
currency_code	N	AN	3 - 3	ISO 4217
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
    "iban_id": 12345678,
    "iban": "GB8888888888888",
    "status_id": 1,
    "currency_code": "EUR",
    "key": "_MERCHANT_KEY_",
    "ts": "_TIMESTAMP_",
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Risk suspend

Webhook which indicates that all related data with this IBAN was suspended by Risk.

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/risk-suspend-account	POST

Request

Parameter	M	Type	Length	Description
iban_id	Y	N	20	IBAN ID.
iban	Y	AN	34	Bank account address - IBAN number
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
    "iban_id": 12345678,
    "iban": "GB8888888888888",
    "key": "_MERCHANT_KEY_",
    "ts": "_TIMESTAMP_",
    "sign": "_SIGN_"
}

Details changed

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/iban-details-changed	POST

Request

Parameter	M	Type	Length	Description
iban_id	Y	N	20
iban	Y	AN	34	Bank account address - IBAN number
account_name	Y	AN	40	Updated Bank account address - Account name
industry_id	N	N	20	Use Get Industries action to know what kind of industries exist. Use 0 value to remove industry.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
    "iban_id": 12345678,
    "iban": "GB8888888888888",
    "account_name": "John Joe",
    "key": "_MERCHANT_KEY_",
    "ts": "_TIMESTAMP_",
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

KYC

Status change

Request

Parameter	M	Type	Length	Description
id	Y	N	20	KYC file ID
msg	Y	AN	255
old_status	Y	N	20
new_status	Y	N	20
old_status_id	Y	N	20	See KYC status.
new_status_id	Y	N	20	See KYC status.
note	Y	AN	255	Request note.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "id": 123456789,
   "msg": "Status changed from [Pending] to [Approved]",  
   "old_status": "Pending",  
   "new_status": "Approved",  
   "old_status_id": 4,  
   "new_status_id": 2,  
   "note": "note",
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Purchase

Finish

Request

Parameter	M	Type	Length	Description
status_id	Y	N	20	See Purchase status.
reference_id	Y	AN	255
order_id	Y	AN	50
data_amount	Y	N	10,2
currency	Y	A	3	ISO 4217
transaction_id	Y	N	20	Unique transaction ID.
first_name	Y	A	50	Payer's first name
last_name	Y	A	50	Payer's last name
error_message	Y	AN	255	If status_id is 8 returns error message.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "status_id": 9,  
   "reference_id": "ap-57fcb50111666",  
   "order_id": "my_order_81815",  
   "data_amount": "10.51",
   "currency": "EUR", 
   "transaction_id": 1166071,
   "first_name": "First",
   "last_name": "Last",
   "error_message": "null",
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Transaction instruction

Cancel instruction

Created

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/iban-cancel-instruction-created	POST

Request

Parameter	M	Type	Length	Description
id	Y	N	20
transaction_id	Y	N	20	Unique transaction ID.
status	Y	N	20	See Cancel request status
type	Y	N	20	See Cancel request type
reason_code	Y	A	3	See Cancel request decline reason codes
created_at	Y	AN	25	ISO 8601
will_finish_at	Y	AN	25	ISO 8601
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
    "id": "15718270609474",
    "transaction_id": "1166071",
    "status": "2",
    "type": "2",
    "reason_code": "682",
    "created_at": "2020-01-20T06:18:23+00:00",
    "will_finish_at": "2020-01-20T06:18:23+00:00",
    "key": "_MERCHANT_KEY_",
    "ts": "_TIMESTAMP_",
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Updated

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/iban-cancel-instruction-updated	POST

Request

Parameter	M	Type	Length	Description
id	Y	N	20
transaction_id	Y	N	20	Unique transaction ID.
status	Y	N	20	See Cancel request status
type	Y	N	20	See Cancel request type
reason_code	Y	A	3	See Cancel request decline reason codes
updated_at	Y	AN	25	ISO 8601
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
    "id": "15718270609474",
    "transaction_id": "1166071",
    "status": "2",
    "type": "2",
    "reason_code": "682",
    "updated_at": "2020-01-20T06:18:23+00:00",
    "key": "_MERCHANT_KEY_",
    "ts": "_TIMESTAMP_",
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Resolution of investigation

Created

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/iban-resolution-of-investigation-instruction-created	POST

Request

Parameter	M	Type	Length	Description
id	Y	N	20
cancel_instruction_id	Y	N	20
transaction_id	Y	N	20	Unique transaction ID.
status	Y	N	20	See Cancel request status
type	Y	N	20	See Cancel request type
reason_code	Y	A	3	See Cancel request decline reason codes
created_at	Y	AN	25	ISO 8601
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
    "id": "15718270609474",
    "cancel_instruction_id": "15795011135021",
    "transaction_id": "1166071",
    "status": "2",
    "type": "2",
    "reason_code": "682",
    "created_at": "2020-01-20T06:18:23+00:00",
    "key": "_MERCHANT_KEY_",
    "ts": "_TIMESTAMP_",
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Updated

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/iban-resolution-of-investigation-instruction-updated	POST

Request

Parameter	M	Type	Length	Description
id	Y	N	20
cancel_instruction_id	Y	N	20
transaction_id	Y	N	20	Unique transaction ID.
status	Y	N	20	See Cancel request status
type	Y	N	20	See Cancel request type
reason_code	Y	A	3	See Cancel request decline reason codes
created_at	Y	AN	25	ISO 8601
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
    "id": "15718270609474",
    "cancel_instruction_id": "15795011135021",
    "transaction_id": "1166071",
    "status": "2",
    "type": "2",
    "reason_code": "682",
    "created_at": "2020-01-20T06:18:23+00:00",
    "key": "_MERCHANT_KEY_",
    "ts": "_TIMESTAMP_",
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Transfer

Account to Direct Debit

Due

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/direct-debit-due	POST

Request

Parameter	M	Type	Length	Description
transaction_id	Y	N	20	Unique transaction ID.
sender_account_id	Y	N	20	Sender's account ID.
sender_iban_id	Y	N	20	Sender's IBAN ID.
sender_iban	Y	AN	34	Sender's bank account address - IBAN number
mandate_id	Y	N	20
mandate_reference	Y	AN	18
originator_id	Y	N	20
originator_name	Y	AN	255
originator_service_user_number	Y	N	6	Unique reference, which identifies originator
receiver_iban	N	AN	34	Receiver's bank account address - IBAN number
receiver_account_name	N	A	255	Receiver's bank account address - Account name
receiver_account_number	N	N	26	Receiver's bank account address - Account number
receiver_sort_code	N	AN	6	Receiver's bank account address - Sort code
receiver_country_iso	N	N	3	Receiver's bank account address - ISO 3166-1 numeric country code
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
transaction_details	Y	AN	255
transaction_scheme	N	N	2	See IBAN transfer schemes.
transaction_identifier	N	AN	100	Unique external transaction identifier.
end_to_end_identifier	N	AN	100	Transaction's end to end identifier.
reference	N	AN	35
due_at	Y	AN	255	Date when money will be sent if you don't change 'should_pay' status
should_pay	Y	N	1	Possible values: 1: yes, 0: no.
created_at	Y	AN	25	ISO 8601
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "transaction_id": "1166071",
   "sender_account_id": "1753154",
   "sender_iban_id": "123456789210",
   "sender_iban": "GB8888888888888888",
   "mandate_id": "123456789210",
   "mandate_reference": "For rent.",
   "originator_id": "123456789",
   "originator_name": "Originator EU",
   "originator_service_user_number": "123456",
   "receiver_iban": "GB77777777777777777",
   "receiverr_account_name": "John Doe",
   "receiver_account_number": "78726600",
   "receiver_sort_code": "660011",
   "receiver_country_iso": "004",
   "amount": "15.00",
   "currency": "GBP",
   "transaction_details": "Direct debit transfer from Account (123456789) for Mandate (123456789210)",
   "transaction_scheme": 4,
   "transaction_identifier": "TX123456789",
   "end_to_end_identifier": "end2End134789",
   "reference": "GRE547877",
   "due_at": "2020-01-21T06:18:23+00:00",
   "should_pay": "1",
   "created_at": "2020-01-20T06:18:23+00:00",
   "key": "_MERCHANT_KEY_",
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Paid

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/direct-debit-paid	POST

Request

Parameter	M	Type	Length	Description
transaction_id	Y	N	20	Unique transaction ID.
sender_account_id	Y	N	20	Sender's account ID.
sender_iban_id	Y	N	20	Sender's IBAN ID.
sender_iban	Y	AN	34	Sender's bank account address - IBAN number
mandate_id	Y	N	20
mandate_reference	Y	AN	18
originator_id	Y	N	20
originator_name	Y	AN	255
originator_service_user_number	Y	N	6	Unique reference, which identifies originator
receiver_iban	N	AN	34	Receiver's bank account address - IBAN number
receiver_account_name	N	A	255	Receiver's bank account address - Account name
receiver_account_number	N	N	26	Receiver's bank account address - Account number
receiver_sort_code	N	AN	6	Receiver's bank account address - Sort code
receiver_country_iso	N	N	3	Receiver's bank account address - ISO 3166-1 numeric country code
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
transaction_details	Y	AN	255
transaction_scheme	N	N	2	See IBAN transfer schemes.
transaction_identifier	N	AN	100	Unique external transaction identifier.
end_to_end_identifier	N	AN	100	Transaction's end to end identifier.
reference	N	AN	35
paid_at	Y	AN	25	ISO 8601
created_at	Y	AN	25	ISO 8601
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "transaction_id": "1166071",
   "sender_account_id": "1753154",
   "sender_iban_id": "123456789210",
   "sender_iban": "GB8888888888888888",
   "mandate_id": "123456789210",
   "mandate_reference": "For rent.",
   "originator_id": "123456789",
   "originator_name": "Originator EU",
   "originator_service_user_number": "123456",
   "receiver_iban": "GB77777777777777777",
   "receiverr_account_name": "John Doe",
   "receiver_account_number": "78726600",
   "receiver_sort_code": "660011",
   "receiver_country_iso": "004",
   "amount": "15.00",
   "currency": "GBP",
   "transaction_details": "Direct debit transfer from Account (123456789) for Mandate (123456789210)",
   "transaction_scheme": 4,
   "transaction_identifier": "TX123456789",
   "end_to_end_identifier": "end2End134789",
   "reference": "GRE547877",
   "paid_at": "2020-01-21T06:18:23+00:00",
   "created_at": "2020-01-20T06:18:23+00:00",
   "key": "_MERCHANT_KEY_",
   "ts": "_TIMESTAMP_",
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Rejected

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/direct-debit-rejected	POST

Request

Parameter	M	Type	Length	Description
transaction_id	Y	N	20	Unique transaction ID.
sender_account_id	Y	N	20	Sender's account ID.
sender_iban_id	Y	N	20	Sender's IBAN ID.
sender_iban	Y	AN	34	Sender's bank account address - IBAN number
mandate_id	Y	N	20
mandate_reference	Y	AN	18
originator_id	Y	N	20
originator_name	Y	AN	255
originator_service_user_number	Y	N	6	Unique reference, which identifies originator
receiver_iban	N	AN	34	Receiver's bank account address - IBAN number
receiver_account_name	N	A	255	Receiver's bank account address - Account name
receiver_account_number	N	N	26	Receiver's bank account address - Account number
receiver_sort_code	N	AN	6	Receiver's bank account address - Sort code
receiver_country_iso	N	N	3	Receiver's bank account address - ISO 3166-1 numeric country code
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
transaction_details	Y	AN	255
transaction_scheme	N	N	2	See IBAN transfer schemes.
transaction_identifier	N	AN	100	Unique external transaction identifier.
end_to_end_identifier	N	AN	100	Transaction's end to end identifier.
reference	N	AN	35
created_at	Y	AN	25	ISO 8601
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "transaction_id": "1166071",
   "sender_account_id": "1753154",
   "sender_iban_id": "123456789210",
   "sender_iban": "GB8888888888888888",
   "mandate_id": "123456789210",
   "mandate_reference": "For rent.",
   "originator_id": "123456789",
   "originator_name": "Originator EU",
   "originator_service_user_number": "123456",
   "receiver_iban": "GB77777777777777777",
   "receiverr_account_name": "John Doe",
   "receiver_account_number": "78726600",
   "receiver_sort_code": "660011",
   "receiver_country_iso": "004",
   "amount": "15.00",
   "currency": "GBP",
   "transaction_details": "Direct debit transfer from Account (123456789) for Mandate (123456789210)",
   "transaction_scheme": 4,
   "transaction_identifier": "TX123456789",
   "end_to_end_identifier": "end2End134789",
   "reference": "GRE547877",
   "created_at": "2020-01-20T06:18:23+00:00",
   "key": "_MERCHANT_KEY_",
   "ts": "_TIMESTAMP_",
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Returned

For webhook information, check Outbound returned. To check if it's for direct debit - please check 'returned_transaction_type' field.

Return rejected

For webhook information, check Outbound return rejected. To check if it's for direct debit - please check 'returned_transaction_type' field.

Paid with return

For webhook information, check Outbound settlement with return. To check if it's for direct debit - please check 'transaction_type' field.

Account to IBAN

Cancel Completed

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/iban-outbound-cancel-completed	POST

Request

Parameter	M	Type	Length	Description
canceled_transaction_id	Y	N	20	Unique canceled transaction ID.
transaction_id	Y	N	20	Unique transaction ID.
receiver_account_id	Y	N	20	Receiver's account ID.
receiver_iban	Y	AN	34	Receiver's bank account address - IBAN number.
receiver_account_name	Y	A	255	Receiver's bank account address - Account name.
receiver_account_number	N	N	26	Receiver's bank account address - Account number.
receiver_sort_code	N	AN	6	Receiver's bank account address - Sort code.
sender_iban	N	AN	34	Sender's bank account address - IBAN number.
sender_account_name	Y	A	255	Sender's bank account address - Account name.
sender_account_number	N	N	26	Sender's bank account address - Account number.
sender_sort_code	N	AN	6	Sender's bank account address - Sort code.
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
notes	Y	AN	255
created_at	Y	AN	25	ISO 8601
request_reference	N	AN	255	Canceled transaction's request reference.
transaction_scheme	N	N	2	See IBAN transfer schemes.
transaction_type	N	N	2	See IBAN transfer types.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "canceled_transaction_id": "1188072",
   "transaction_id": "1166071",
   "receiver_account_id": "1753154",
   "receiver_iban": "GB8888888888888888",
   "receiver_account_name": "John Joe",
   "receiver_account_number": "78726600",
   "receiver_sort_code": "660011",
   "sender_iban": "GB77777777777777777",
   "sender_account_name": "John Joe",
   "sender_account_number": "78726711",
   "sender_sort_code": "671100",
   "amount": "5.00",
   "currency": "GBP",
   "notes": "Cancel of transfer from Account (1753154) to IBAN (GB77777777777777777).",
   "created_at": "2019-12-16T13:42:39+00:00",
   "request_reference": "AAA12345789",
   "transaction_type": 11,
   "transaction_scheme": 5,
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Cancel Rejected

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/iban-outbound-cancel-rejected	POST

Request

Parameter	M	Type	Length	Description
canceled_transaction_id	Y	N	20	Unique canceled transaction ID.
request_reference	N	AN	255	Canceled transaction's request reference
reason_code	Y	N	20	See Outbound cancel rejection reason codes
reason	Y	AN	255
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "canceled_transaction_id": "1166071",
   "request_reference": "AAA12345789",
   "reason_code": "673",
   "reason": "Wrong amount.",
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Reject

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/iban-outbound-rejected	POST

Request

Parameter	M	Type	Length	Description
transaction_id	Y	N	20	Unique transaction ID.
sender_account_id	Y	N	20	Sender's account ID.
sender_iban	Y	AN	34	Sender's bank account address - IBAN number
sender_account_name	Y	A	255	Sender's bank account address - Account name
receiver_iban	N	AN	34	Receiver's bank account address - IBAN number
receiver_account_name	Y	A	255	Receiver's bank account address - Account name
receiver_account_number	N	N	26	Receiver's bank account address - Account number
receiver_sort_code	N	AN	6	Receiver's bank account address - Sort code
receiver_country_iso	N	N	3	Receiver's bank account address - ISO 3166-1 numeric country code
receiver_bank_name	N	AN	140	Receiver's bank - Name
receiver_bank_bic	N	AN	140	Receiver's bank - BIC
receiver_bank_routing_number	N	AN	35	Receiver's bank - Routing number (ABA)
receiver_bank_clearing_system_iso_code	N	AN	35	Receiver's bank - Clearing system code (ISO 20022)
receiver_bank_clearing_system_member_id	N	AN	35	Receiver's bank - Clearing system member ID
receiver_bank_country_iso	N	AN	3	Receiver's bank - ISO 3166-1 numeric country code
ultimate_sender_name	N	AN	70	Ultimate sender - name.
ultimate_sender_country_iso	N	AN	3 - 3	Ultimate sender - country. ISO 3166-1 numeric country code.
ultimate_sender_organization_code	N	AN	11	Ultimate sender - organization code.
ultimate_sender_birth_date	N	AN	-	Ultimate sender - birth date. Must be valid date (Y-M-D format).
ultimate_sender_birth_city	N	AN	35	Ultimate sender - birth city.
ultimate_sender_birth_country_iso	N	AN	3 - 3	Ultimate sender - birth country. ISO 3166-1 numeric country code.
ultimate_sender_private_identifier	N	AN	35	Ultimate sender - private identifier.
ultimate_sender_private_issuer	N	AN	35	Ultimate sender - private issuer.
ultimate_sender_private_code	N	AN	4	Ultimate sender - private code.
ultimate_sender_private_proprietary	N	AN	35	Ultimate sender - private proprietary.
ultimate_sender_organization	N	AN	-	Ultimate sender - is organization. Available values - true/false.
ultimate_receiver_name	N	AN	70	Ultimate receiver - name.
ultimate_receiver_country_iso	N	AN	3 - 3	Ultimate receiver - country. ISO 3166-1 numeric country code.
ultimate_receiver_organization_code	N	AN	11	Ultimate receiver - organization code.
ultimate_receiver_birth_date	N	AN	-	Ultimate receiver - birth date. Must be valid date (Y-M-D format).
ultimate_receiver_birth_city	N	AN	35	Ultimate receiver - birth city.
ultimate_receiver_birth_country_iso	N	AN	3 - 3	Ultimate receiver - birth country. ISO 3166-1 numeric country code.
ultimate_receiver_private_identifier	N	AN	35	Ultimate receiver - private identifier.
ultimate_receiver_private_issuer	N	AN	35	Ultimate receiver - private issuer.
ultimate_receiver_private_code	N	AN	4	Ultimate receiver - private code.
ultimate_receiver_private_proprietary	N	AN	35	Ultimate receiver - private proprietary.
ultimate_receiver_organization	N	AN	-	Ultimate receiver - is organization. Available values - true/false.
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
transaction_status	Y	N	20	See IBAN transaction status.
notes	Y	AN	255
supplementary_data	N	AN		Bank provided supplementary data in JSON.
created_at	Y	AN	25	ISO 8601
request_reference	N	AN	255	Transaction's request reference
reason_code	Y	AN	3	See Reason codes.
reason_description	Y	AN	255	Description of reason. In bank error cases - reason might be different from what you see near reason code.
bank_provider_reason_code	N	AN	255	Reason code provided by bank provider.
transaction_scheme	N	N	2	See IBAN transfer schemes.
transaction_type	N	N	2	See IBAN transfer types.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "transaction_id": "1166071",
   "sender_account_id": "1753154",
   "sender_iban": "GB8888888888888888",
   "sender_account_name": "John Joe",
   "receiver_iban": "GB77777777777777777",
   "receiver_account_name": "John Doe",
   "receiver_account_number": "78726600",
   "receiver_sort_code": "660011",
   "receiver_country_iso": "004",
   "receiver_bank_name": "Barclays",
   "receiver_bank_bic": "HABALT22",
   "receiver_bank_routing_number": "",
   "receiver_bank_clearing_system_iso_code": "",
   "receiver_bank_clearing_system_member_id": "",
   "receiver_bank_country_iso": "004",
   "ultimate_sender_name": "Jones Ltd.",
   "ultimate_sender_country_iso": "004",
   "ultimate_sender_organization_code": "004",
   "ultimate_sender_birth_date": "1986-06-08",
   "ultimate_sender_birth_city": "London",
   "ultimate_sender_birth_country_iso": "004",
   "ultimate_sender_private_identifier": "ID-2345",
   "ultimate_sender_private_issuer": "IS-12345",
   "ultimate_sender_private_code": "0004",
   "ultimate_sender_private_proprietary": "Property",
   "ultimate_sender_organization": "true",
   "ultimate_receiver_name": "Anthony Ltd.",
   "ultimate_receiver_country_iso": "004",
   "ultimate_receiver_organization_code": "005",
   "ultimate_receiver_birth_date": "1977-08-08",
   "ultimate_receiver_birth_city": "London",
   "ultimate_receiver_birth_country_iso": "004",
   "ultimate_receiver_private_identifier": "ID-3555",
   "ultimate_receiver_private_issuer": "IS-333",
   "ultimate_receiver_private_code": "1111",
   "ultimate_receiver_private_proprietary": "Property",
   "ultimate_receiver_organization": "true",
   "amount": "5.00",
   "currency": "GBP",
   "transaction_status": "6",
   "notes": "Transfer from Account (1753154) to IBAN (GB77777777777777777)",
   "supplementary_data": "[{\"Name\":\"Amount\",\"Value\":\"100000.0\"},{\"Name\":\"BeneficiaryCreditInstitution\",\"Value\":\"040473\"}]",
   "created_at": "2019-12-16T13:42:39+00:00",
   "request_reference": "AAA12345789",
   "reason_code": 536,
   "reason_description": "IBAN not found",
   "bank_provider_reason_code": "333DH",
   "transaction_type": 1,
   "transaction_scheme": 5,
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Return

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/iban-outbound-returned	POST

Request

Parameter	M	Type	Length	Description
transaction_id	Y	N	20	Unique transaction ID.
returned_transaction_id	Y	N	20	Unique returned transaction ID.
returned_transaction_type	N	N	2	Returned transaction's type. See IBAN transfer types.
request_reference	N	AN	255	Returned transaction's request reference.
receiver_account_id	Y	N	20	Receiver's account ID.
receiver_iban	Y	AN	34	Receiver's bank account address - IBAN number
receiver_account_name	Y	A	255	Receiver's bank account address - Account name
receiver_account_number	N	N	26	Receiver's bank account address - Account number
receiver_sort_code	N	AN	6	Receiver's bank account address - Sort code
sender_iban	N	AN	34	Sender's bank account address - IBAN number
sender_account_name	Y	A	255	Sender's bank account address - Account name
sender_account_number	N	N	26	Sender's bank account address - Account number
sender_sort_code	N	AN	6	Sender's bank account address - Sort code
sender_country_iso	N	N	3	Sender's bank account address - ISO 3166-1 numeric country code
ultimate_sender_name	N	AN	70	Ultimate sender - name.
ultimate_sender_country_iso	N	AN	3 - 3	Ultimate sender - country. ISO 3166-1 numeric country code.
ultimate_sender_organization_code	N	AN	11	Ultimate sender - organization code.
ultimate_sender_birth_date	N	AN	-	Ultimate sender - birth date. Must be valid date (Y-M-D format).
ultimate_sender_birth_city	N	AN	35	Ultimate sender - birth city.
ultimate_sender_birth_country_iso	N	AN	3 - 3	Ultimate sender - birth country. ISO 3166-1 numeric country code.
ultimate_sender_private_identifier	N	AN	35	Ultimate sender - private identifier.
ultimate_sender_private_issuer	N	AN	35	Ultimate sender - private issuer.
ultimate_sender_private_code	N	AN	4	Ultimate sender - private code.
ultimate_sender_private_proprietary	N	AN	35	Ultimate sender - private proprietary.
ultimate_sender_organization	N	AN	-	Ultimate sender - is organization. Available values - true/false.
ultimate_receiver_name	N	AN	70	Ultimate receiver - name.
ultimate_receiver_country_iso	N	AN	3 - 3	Ultimate receiver - country. ISO 3166-1 numeric country code.
ultimate_receiver_organization_code	N	AN	11	Ultimate receiver - organization code.
ultimate_receiver_birth_date	N	AN	-	Ultimate receiver - birth date. Must be valid date (Y-M-D format).
ultimate_receiver_birth_city	N	AN	35	Ultimate receiver - birth city.
ultimate_receiver_birth_country_iso	N	AN	3 - 3	Ultimate receiver - birth country. ISO 3166-1 numeric country code.
ultimate_receiver_private_identifier	N	AN	35	Ultimate receiver - private identifier.
ultimate_receiver_private_issuer	N	AN	35	Ultimate receiver - private issuer.
ultimate_receiver_private_code	N	AN	4	Ultimate receiver - private code.
ultimate_receiver_private_proprietary	N	AN	35	Ultimate receiver - private proprietary.
ultimate_receiver_organization	N	AN	-	Ultimate receiver - is organization. Available values - true/false.
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
transaction_status	Y	N	20	See IBAN transaction status.
notes	Y	AN	255
supplementary_data	N	AN		Bank provided supplementary data in JSON.
iso20022_xml_document	N	AN	0 - 80000	Bank provided CHAPS ISO20022 message in XML.
reason	Y	AN	255
reason_code	N	AN	3	See IBAN Outbound return message codes.
return_request_reference	N	AN	255	Initiated request reference with return call.
reference	N	AN	255	Transaction reference.
transaction_identifier	N	AN	100	Unique external transaction identifier.
end_to_end_identifier	N	AN	255	Transaction's end to end identifier.
created_at	Y	AN	25	ISO 8601
transaction_scheme	N	N	2	See IBAN transfer schemes.
transaction_type	N	N	2	See IBAN transfer types.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "transaction_id": "1166071",
   "returned_transaction_id": "1188072",
   "returned_transaction_type": 1,
   "request_reference": "AAA12345789",
   "receiver_account_id": "1753154",
   "receiver_iban": "GB8888888888888888",
   "receiver_account_name": "John Doe",
   "receiver_account_number": "78726600",
   "receiver_sort_code": "660011",
   "sender_iban": "GB77777777777777777",
   "sender_account_name": "John Joe",
   "sender_account_number": "78726711",
   "sender_sort_code": "671100",
   "sender_country_iso": "004",
   "ultimate_sender_name": "Jones Ltd.",
   "ultimate_sender_country_iso": "004",
   "ultimate_sender_organization_code": "004",
   "ultimate_sender_birth_date": "1986-06-08",
   "ultimate_sender_birth_city": "London",
   "ultimate_sender_birth_country_iso": "004",
   "ultimate_sender_private_identifier": "ID-2345",
   "ultimate_sender_private_issuer": "IS-12345",
   "ultimate_sender_private_code": "0004",
   "ultimate_sender_private_proprietary": "Property",
   "ultimate_sender_organization": "true",
   "ultimate_receiver_name": "Anthony Ltd.",
   "ultimate_receiver_country_iso": "004",
   "ultimate_receiver_organization_code": "005",
   "ultimate_receiver_birth_date": "1977-08-08",
   "ultimate_receiver_birth_city": "London",
   "ultimate_receiver_birth_country_iso": "004",
   "ultimate_receiver_private_identifier": "ID-3555",
   "ultimate_receiver_private_issuer": "IS-333",
   "ultimate_receiver_private_code": "1111",
   "ultimate_receiver_private_proprietary": "Property",
   "ultimate_receiver_organization": "true",
   "amount": "5.00",
   "currency": "GBP",
   "transaction_status": "7",
   "notes": "Return of transfer from Account (1753154) to IBAN (GB77777777777777777). Reason - Account blocked.",
   "supplementary_data": "[{\"Name\":\"Amount\",\"Value\":\"100000.0\"},{\"Name\":\"BeneficiaryCreditInstitution\",\"Value\":\"040473\"}]",
   "iso20022_xml_document": "<Document xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns=\"urn:iso:std:iso:20022:tech:xsd:pacs.008.001.08\"><FIToFICstmrCdtTrf><GrpHdr><CreDtTm>1900-02-03T04:00:30+00:00</CreDtTm><NbOfTxs>1</NbOfTxs></GrpHdr><CdtTrfTxInf><PmtId><InstrId>Id12</InstrId><EndToEndId>EndId21</EndToEndId><UETR>d9bd8c6e-e1d9-405b-ac53-2fa197149d09</UETR></PmtId><IntrBkSttlmAmt Ccy=\"Eur\">1.01</IntrBkSttlmAmt><IntrBkSttlmDt>1900-11-01</IntrBkSttlmDt><ChrgBr>DEBT</ChrgBr><Dbtr><Nm>ExampleName</Nm></Dbtr><DbtrAcct><Id><IBAN>GB00AABB00001111000111</IBAN></Id></DbtrAcct><DbtrAgt><FinInstnId><BICFI>LLAABB11XXX</BICFI></FinInstnId></DbtrAgt><CdtrAgt><FinInstnId><BICFI>LLAABB11XXX</BICFI></FinInstnId></CdtrAgt><CdtrAcct><Id><IBAN>GB00AABB00001111000112</IBAN></Id></CdtrAcct><RmtInf><Ustrd>ExampleReference1</Ustrd></RmtInf></CdtTrfTxInf></FIToFICstmrCdtTrf></Document>",
   "reason": "Account blocked.",
   "reason_code": "651",
   "return_request_reference": "AAABBBCCC111",
   "reference": "RBB1244588",
   "transaction_identifier": "819ecc43-ac3e-441c-af8d-13ea57acfa64",
   "end_to_end_identifier": "6660e913-e461-44ea-af60-b074036720c2",
   "created_at": "2019-12-16T13:42:39+00:00",
   "transaction_type": 5,
   "transaction_scheme": 5,
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Return rejected

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/iban-outbound-return-rejected	POST

Request

Parameter	M	Type	Length	Description
transaction_id	Y	N	20	Unique transaction ID.
returned_transaction_id	Y	N	20	Unique returned transaction ID.
returned_transaction_type	N	N	2	Returned transaction's type. See IBAN transfer types.
request_reference	N	AN	255	Returned transaction's request reference.
receiver_account_id	Y	N	20	Receiver's account ID.
receiver_iban	Y	AN	34	Receiver's bank account address - IBAN number.
receiver_account_name	Y	A	255	Receiver's bank account address - Account name.
receiver_account_number	N	N	26	Receiver's bank account address - Account number.
receiver_sort_code	N	AN	6	Receiver's bank account address - Sort code.
sender_iban	N	AN	34	Sender's bank account address - IBAN number.
sender_account_name	Y	A	255	Sender's bank account address - Account name.
sender_account_number	N	N	26	Sender's bank account address - Account number.
sender_sort_code	N	AN	6	Sender's bank account address - Sort code.
sender_country_iso	N	N	3	Sender's bank account address - ISO 3166-1 numeric country code.
ultimate_sender_name	N	AN	70	Ultimate sender - name.
ultimate_sender_country_iso	N	AN	3 - 3	Ultimate sender - country. ISO 3166-1 numeric country code.
ultimate_sender_organization_code	N	AN	11	Ultimate sender - organization code.
ultimate_sender_birth_date	N	AN	-	Ultimate sender - birth date. Must be valid date (Y-M-D format).
ultimate_sender_birth_city	N	AN	35	Ultimate sender - birth city.
ultimate_sender_birth_country_iso	N	AN	3 - 3	Ultimate sender - birth country. ISO 3166-1 numeric country code.
ultimate_sender_private_identifier	N	AN	35	Ultimate sender - private identifier.
ultimate_sender_private_issuer	N	AN	35	Ultimate sender - private issuer.
ultimate_sender_private_code	N	AN	4	Ultimate sender - private code.
ultimate_sender_private_proprietary	N	AN	35	Ultimate sender - private proprietary.
ultimate_sender_organization	N	AN	-	Ultimate sender - is organization. Available values - true/false.
ultimate_receiver_name	N	AN	70	Ultimate receiver - name.
ultimate_receiver_country_iso	N	AN	3 - 3	Ultimate receiver - country. ISO 3166-1 numeric country code.
ultimate_receiver_organization_code	N	AN	11	Ultimate receiver - organization code.
ultimate_receiver_birth_date	N	AN	-	Ultimate receiver - birth date. Must be valid date (Y-M-D format).
ultimate_receiver_birth_city	N	AN	35	Ultimate receiver - birth city.
ultimate_receiver_birth_country_iso	N	AN	3 - 3	Ultimate receiver - birth country. ISO 3166-1 numeric country code.
ultimate_receiver_private_identifier	N	AN	35	Ultimate receiver - private identifier.
ultimate_receiver_private_issuer	N	AN	35	Ultimate receiver - private issuer.
ultimate_receiver_private_code	N	AN	4	Ultimate receiver - private code.
ultimate_receiver_private_proprietary	N	AN	35	Ultimate receiver - private proprietary.
ultimate_receiver_organization	N	AN	-	Ultimate receiver - is organization. Available values - true/false.
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
notes	Y	AN	255
supplementary_data	N	AN		Bank provided supplementary data in JSON.
iso20022_xml_document	N	AN	0 - 80000	Bank provided CHAPS ISO20022 message in XML.
reason	Y	AN	255
reason_code	N	AN	3	See IBAN Outbound return message codes.
bank_provider_reason_code	N	AN	255	Reason code provided by bank provider.
reference	N	AN	255	Transaction reference.
transaction_identifier	N	AN	100	Unique external transaction identifier.
end_to_end_identifier	N	AN	255	Transaction's end to end identifier.
return_request_reference	N	AN	255	Initiated request reference with return call.
created_at	Y	AN	25	ISO 8601
transaction_status	Y	N	20	See IBAN transaction status.
transaction_scheme	N	N	2	See IBAN transfer schemes.
transaction_type	N	N	2	See IBAN transfer types.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "transaction_id": "1166071",
   "returned_transaction_id": "1188072",
   "returned_transaction_type": 1,
   "request_reference": "AAA12345789",
   "receiver_account_id": "1753154",
   "receiver_iban": "GB8888888888888888",
   "receiver_account_name": "John Doe",
   "receiver_account_number": "78726600",
   "receiver_sort_code": "660011",
   "sender_iban": "GB77777777777777777",
   "sender_account_name": "John Joe",
   "sender_account_number": "78726711",
   "sender_sort_code": "671100",
   "sender_country_iso": "004",
   "ultimate_sender_name": "Jones Ltd.",
   "ultimate_sender_country_iso": "004",
   "ultimate_sender_organization_code": "004",
   "ultimate_sender_birth_date": "1986-06-08",
   "ultimate_sender_birth_city": "London",
   "ultimate_sender_birth_country_iso": "004",
   "ultimate_sender_private_identifier": "ID-2345",
   "ultimate_sender_private_issuer": "IS-12345",
   "ultimate_sender_private_code": "0004",
   "ultimate_sender_private_proprietary": "Property",
   "ultimate_sender_organization": "true",
   "ultimate_receiver_name": "Anthony Ltd.",
   "ultimate_receiver_country_iso": "004",
   "ultimate_receiver_organization_code": "005",
   "ultimate_receiver_birth_date": "1977-08-08",
   "ultimate_receiver_birth_city": "London",
   "ultimate_receiver_birth_country_iso": "004",
   "ultimate_receiver_private_identifier": "ID-3555",
   "ultimate_receiver_private_issuer": "IS-333",
   "ultimate_receiver_private_code": "1111",
   "ultimate_receiver_private_proprietary": "Property",
   "ultimate_receiver_organization": "true",
   "amount": "5.00",
   "currency": "GBP",
   "notes": "Return of transfer from Account (1753154) to IBAN (GB77777777777777777). Reason - Account blocked.",
   "supplementary_data": "[{\"Name\":\"Amount\",\"Value\":\"100000.0\"},{\"Name\":\"BeneficiaryCreditInstitution\",\"Value\":\"040473\"}]",
   "iso20022_xml_document": "<Document xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns=\"urn:iso:std:iso:20022:tech:xsd:pacs.008.001.08\"><FIToFICstmrCdtTrf><GrpHdr><CreDtTm>1900-02-03T04:00:30+00:00</CreDtTm><NbOfTxs>1</NbOfTxs></GrpHdr><CdtTrfTxInf><PmtId><InstrId>Id12</InstrId><EndToEndId>EndId21</EndToEndId><UETR>d9bd8c6e-e1d9-405b-ac53-2fa197149d09</UETR></PmtId><IntrBkSttlmAmt Ccy=\"Eur\">1.01</IntrBkSttlmAmt><IntrBkSttlmDt>1900-11-01</IntrBkSttlmDt><ChrgBr>DEBT</ChrgBr><Dbtr><Nm>ExampleName</Nm></Dbtr><DbtrAcct><Id><IBAN>GB00AABB00001111000111</IBAN></Id></DbtrAcct><DbtrAgt><FinInstnId><BICFI>LLAABB11XXX</BICFI></FinInstnId></DbtrAgt><CdtrAgt><FinInstnId><BICFI>LLAABB11XXX</BICFI></FinInstnId></CdtrAgt><CdtrAcct><Id><IBAN>GB00AABB00001111000112</IBAN></Id></CdtrAcct><RmtInf><Ustrd>ExampleReference1</Ustrd></RmtInf></CdtTrfTxInf></FIToFICstmrCdtTrf></Document>",
   "reason": "Account blocked.",
   "reason_code": "651",
   "bank_provider_reason_code": "333DH",
   "reference": "RBB1244588",
   "transaction_identifier": "819ecc43-ac3e-441c-af8d-13ea57acfa64",
   "end_to_end_identifier": "6660e913-e461-44ea-af60-b074036720c2",
   "return_request_reference": "AAABBBCCC111",
   "created_at": "2019-12-16T13:42:39+00:00",
   "transaction_status": 6,
   "transaction_type": 5,
   "transaction_scheme": 5,
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Settlement

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/iban-outbound-settled	POST

Request

Parameter	M	Type	Length	Description
transaction_id	Y	N	20	Unique transaction ID.
sender_account_id	Y	N	20	Sender's account ID.
sender_iban	Y	AN	34	Sender's bank account address - IBAN number
sender_account_name	Y	A	255	Sender's bank account address - Account name
receiver_iban	N	AN	34	Receiver's bank account address - IBAN number
receiver_account_name	Y	A	255	Receiver's bank account address - Account name
receiver_account_number	N	N	26	Receiver's bank account address - Account number
receiver_sort_code	N	AN	6	Receiver's bank account address - Sort code
receiver_country_iso	N	AN	3	Receiver's bank account address - ISO 3166-1 numeric country code
receiver_bank_name	N	AN	140	Receiver's bank - Name
receiver_bank_bic	N	AN	140	Receiver's bank - BIC
receiver_bank_routing_number	N	AN	35	Receiver's bank - Routing number (ABA)
receiver_bank_clearing_system_iso_code	N	AN	35	Receiver's bank - Clearing system code (ISO 20022)
receiver_bank_clearing_system_member_id	N	AN	35	Receiver's bank - Clearing system member ID
receiver_bank_country_iso	N	AN	3	Receiver's bank - ISO 3166-1 numeric country code
ultimate_sender_name	N	AN	70	Ultimate sender - name.
ultimate_sender_country_iso	N	AN	3 - 3	Ultimate sender - country. ISO 3166-1 numeric country code.
ultimate_sender_organization_code	N	AN	11	Ultimate sender - organization code.
ultimate_sender_birth_date	N	AN	-	Ultimate sender - birth date. Must be valid date (Y-M-D format).
ultimate_sender_birth_city	N	AN	35	Ultimate sender - birth city.
ultimate_sender_birth_country_iso	N	AN	3 - 3	Ultimate sender - birth country. ISO 3166-1 numeric country code.
ultimate_sender_private_identifier	N	AN	35	Ultimate sender - private identifier.
ultimate_sender_private_issuer	N	AN	35	Ultimate sender - private issuer.
ultimate_sender_private_code	N	AN	4	Ultimate sender - private code.
ultimate_sender_private_proprietary	N	AN	35	Ultimate sender - private proprietary.
ultimate_sender_organization	N	AN	-	Ultimate sender - is organization. Available values - true/false.
ultimate_receiver_name	N	AN	70	Ultimate receiver - name.
ultimate_receiver_country_iso	N	AN	3 - 3	Ultimate receiver - country. ISO 3166-1 numeric country code.
ultimate_receiver_organization_code	N	AN	11	Ultimate receiver - organization code.
ultimate_receiver_birth_date	N	AN	-	Ultimate receiver - birth date. Must be valid date (Y-M-D format).
ultimate_receiver_birth_city	N	AN	35	Ultimate receiver - birth city.
ultimate_receiver_birth_country_iso	N	AN	3 - 3	Ultimate receiver - birth country. ISO 3166-1 numeric country code.
ultimate_receiver_private_identifier	N	AN	35	Ultimate receiver - private identifier.
ultimate_receiver_private_issuer	N	AN	35	Ultimate receiver - private issuer.
ultimate_receiver_private_code	N	AN	4	Ultimate receiver - private code.
ultimate_receiver_private_proprietary	N	AN	35	Ultimate receiver - private proprietary.
ultimate_receiver_organization	N	AN	-	Ultimate receiver - is organization. Available values - true/false.
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
transaction_status	Y	N	20	See IBAN transaction status.
notes	Y	AN	255
supplementary_data	N	AN		Bank provided supplementary data in JSON.
request_reference	N	AN	255	Transaction's request reference
transaction_identifier	N	AN	100	Unique external transaction identifier
end_to_end_identifier	N	AN	100	Transaction's end to end identifier
created_at	Y	AN	25	ISO 8601
transaction_scheme	N	N	2	See IBAN transfer schemes.
transaction_type	N	N	2	See IBAN transfer types.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "transaction_id": "1166071",
   "sender_account_id": "1753154",
   "sender_iban": "GB8888888888888888",
   "sender_account_name": "John Joe",
   "receiver_iban": "GB77777777777777777",
   "receiverr_account_name": "John Doe",
   "receiver_account_number": "78726600",
   "receiver_sort_code": "660011",
   "receiver_country_iso": "004",
   "receiver_bank_name": "Barclays",
   "receiver_bank_bic": "HABALT22",
   "receiver_bank_routing_number": "",
   "receiver_bank_clearing_system_iso_code": "",
   "receiver_bank_clearing_system_member_id": "",
   "receiver_bank_country_iso": "004",
   "ultimate_sender_name": "Jones Ltd.",
   "ultimate_sender_country_iso": "004",
   "ultimate_sender_organization_code": "004",
   "ultimate_sender_birth_date": "1986-06-08",
   "ultimate_sender_birth_city": "London",
   "ultimate_sender_birth_country_iso": "004",
   "ultimate_sender_private_identifier": "ID-2345",
   "ultimate_sender_private_issuer": "IS-12345",
   "ultimate_sender_private_code": "0004",
   "ultimate_sender_private_proprietary": "Property",
   "ultimate_sender_organization": "true",
   "ultimate_receiver_name": "Anthony Ltd.",
   "ultimate_receiver_country_iso": "004",
   "ultimate_receiver_organization_code": "005",
   "ultimate_receiver_birth_date": "1977-08-08",
   "ultimate_receiver_birth_city": "London",
   "ultimate_receiver_birth_country_iso": "004",
   "ultimate_receiver_private_identifier": "ID-3555",
   "ultimate_receiver_private_issuer": "IS-333",
   "ultimate_receiver_private_code": "1111",
   "ultimate_receiver_private_proprietary": "Property",
   "ultimate_receiver_organization": "true",
   "amount": "5.00",
   "currency": "GBP",
   "transaction_status": "5",
   "notes": "Transfer from Account (1753154) to IBAN (GB77777777777777777)",
   "supplementary_data": "[{\"Name\":\"Amount\",\"Value\":\"100000.0\"},{\"Name\":\"BeneficiaryCreditInstitution\",\"Value\":\"040473\"}]",
   "request_reference": "AAA12345789",
   "transaction_identifier": "TX123456789",
   "end_to_end_identifier": null,
   "created_at": "2019-12-16T13:42:39+00:00",
   "transaction_type": 1,
   "transaction_scheme": 5,
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Settlement with return

This webhook is for cases when a third party initiates the outbound return. Make sure outbound and return transactions exist based on their transaction IDs.

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/iban-outbound-settled-with-return	POST

Request

Parameter	M	Type	Length	Description
return_transaction_id	Y	N	20	Unique return transaction ID.
return_reason	Y	N	3	Return reason.
return_reason_code	Y	N	3	See IBAN Outbound return message codes.
transaction_id	Y	N	20	Unique transaction ID.
sender_account_id	Y	N	20	Sender's account ID.
sender_iban	Y	AN	34	Sender's bank account address - IBAN number.
sender_account_name	Y	A	255	Sender's bank account address - Account name.
receiver_iban	N	AN	34	Receiver's bank account address - IBAN number.
receiver_account_name	Y	A	255	Receiver's bank account address - Account name.
receiver_account_number	N	N	26	Receiver's bank account address - Account number.
receiver_sort_code	N	AN	6	Receiver's bank account address - Sort code.
receiver_country_iso	N	N	3	Receiver's bank account address - ISO 3166-1 numeric country code.
ultimate_sender_name	N	AN	70	Ultimate sender - name.
ultimate_sender_country_iso	N	AN	3 - 3	Ultimate sender - country. ISO 3166-1 numeric country code.
ultimate_sender_organization_code	N	AN	11	Ultimate sender - organization code.
ultimate_sender_birth_date	N	AN	-	Ultimate sender - birth date. Must be valid date (Y-M-D format).
ultimate_sender_birth_city	N	AN	35	Ultimate sender - birth city.
ultimate_sender_birth_country_iso	N	AN	3 - 3	Ultimate sender - birth country. ISO 3166-1 numeric country code.
ultimate_sender_private_identifier	N	AN	35	Ultimate sender - private identifier.
ultimate_sender_private_issuer	N	AN	35	Ultimate sender - private issuer.
ultimate_sender_private_code	N	AN	4	Ultimate sender - private code.
ultimate_sender_private_proprietary	N	AN	35	Ultimate sender - private proprietary.
ultimate_sender_organization	N	AN	-	Ultimate sender - is organization. Available values - true/false.
ultimate_receiver_name	N	AN	70	Ultimate receiver - name.
ultimate_receiver_country_iso	N	AN	3 - 3	Ultimate receiver - country. ISO 3166-1 numeric country code.
ultimate_receiver_organization_code	N	AN	11	Ultimate receiver - organization code.
ultimate_receiver_birth_date	N	AN	-	Ultimate receiver - birth date. Must be valid date (Y-M-D format).
ultimate_receiver_birth_city	N	AN	35	Ultimate receiver - birth city.
ultimate_receiver_birth_country_iso	N	AN	3 - 3	Ultimate receiver - birth country. ISO 3166-1 numeric country code.
ultimate_receiver_private_identifier	N	AN	35	Ultimate receiver - private identifier.
ultimate_receiver_private_issuer	N	AN	35	Ultimate receiver - private issuer.
ultimate_receiver_private_code	N	AN	4	Ultimate receiver - private code.
ultimate_receiver_private_proprietary	N	AN	35	Ultimate receiver - private proprietary.
ultimate_receiver_organization	N	AN	-	Ultimate receiver - is organization. Available values - true/false.
mandate_id	N	N	20	Only available with Direct debit transaction type.
mandate_reference	N	AN	18	Only available with Direct debit transaction type.
originator_id	N	N	20	Only available with Direct debit transaction type.
originator_name	N	AN	255	Only available with Direct debit transaction type.
originator_service_user_number	N	N	6	Unique reference, which identifies originator. Only available with Direct debit transaction type. |
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
notes	Y	AN	255
request_reference	N	AN	255	Transaction's request reference.
transaction_identifier	N	AN	100	Unique external transaction identifier.
end_to_end_identifier	N	AN	100	Transaction's end to end identifier.
reference	N	AN	35
created_at	Y	AN	25	ISO 8601
transaction_status	Y	N	20	See IBAN transaction status.
transaction_scheme	N	N	2	See IBAN transfer schemes.
transaction_type	N	N	2	See IBAN transfer types.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "return_transaction_id": "1188072",
   "return_reason":"Regulatory reason",
   "return_reason_code":"658",
   "transaction_id": "1166071",
   "sender_account_id": "1753154",
   "sender_iban": "GB8888888888888888",
   "sender_account_name": "John Joe",
   "receiver_iban": "GB77777777777777777",
   "receiver_account_name": "John Doe",
   "receiver_account_number": "78726600",
   "receiver_sort_code": "660011",
   "receiver_country_iso": "004",
   "ultimate_sender_name": "Jones Ltd.",
   "ultimate_sender_country_iso": "004",
   "ultimate_sender_organization_code": "004",
   "ultimate_sender_birth_date": "1986-06-08",
   "ultimate_sender_birth_city": "London",
   "ultimate_sender_birth_country_iso": "004",
   "ultimate_sender_private_identifier": "ID-2345",
   "ultimate_sender_private_issuer": "IS-12345",
   "ultimate_sender_private_code": "0004",
   "ultimate_sender_private_proprietary": "Property",
   "ultimate_sender_organization": "true",
   "ultimate_receiver_name": "Anthony Ltd.",
   "ultimate_receiver_country_iso": "004",
   "ultimate_receiver_organization_code": "005",
   "ultimate_receiver_birth_date": "1977-08-08",
   "ultimate_receiver_birth_city": "London",
   "ultimate_receiver_birth_country_iso": "004",
   "ultimate_receiver_private_identifier": "ID-3555",
   "ultimate_receiver_private_issuer": "IS-333",
   "ultimate_receiver_private_code": "1111",
   "ultimate_receiver_private_proprietary": "Property",
   "ultimate_receiver_organization": "true",
   "mandate_id": "123456789210",
   "mandate_reference": "For rent.",
   "originator_id": "123456789",
   "originator_name": "Originator EU",
   "originator_service_user_number": "123456",
   "amount": "5.00",
   "currency": "GBP",
   "notes": "Direct debit transfer from Account (1753154) for Mandate (name - Originator EU, reference - For rent.)",
   "request_reference": "AAA12345789",
   "transaction_identifier": "TX123456789",
   "end_to_end_identifier": null,
   "reference": "GRE547877",
   "created_at": "2019-12-16T13:42:39+00:00",
   "transaction_status": 5,
   "transaction_type": 6,
   "transaction_scheme": 5,
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Held

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/iban-outbound-held	POST

Request

Parameter	M	Type	Length	Description
transaction_id	Y	N	20	Unique transaction ID.
sender_account_id	Y	N	20	Sender's account ID.
sender_iban	Y	AN	34	Sender's bank account address - IBAN number
sender_account_name	Y	A	255	Sender's bank account address - Account name
receiver_iban	N	AN	34	Receiver's bank account address - IBAN number
receiver_account_name	Y	A	255	Receiver's bank account address - Account name
receiver_account_number	N	N	26	Receiver's bank account address - Account number
receiver_sort_code	N	AN	6	Receiver's bank account address - Sort code
receiver_country_iso	N	AN	3	Receiver's bank account address - ISO 3166-1 numeric country code
receiver_bank_name	N	AN	140	Receiver's bank - Name
receiver_bank_bic	N	AN	140	Receiver's bank - BIC
receiver_bank_routing_number	N	AN	35	Receiver's bank - Routing number (ABA)
receiver_bank_clearing_system_iso_code	N	AN	35	Receiver's bank - Clearing system code (ISO 20022)
receiver_bank_clearing_system_member_id	N	AN	35	Receiver's bank - Clearing system member ID
receiver_bank_country_iso	N	AN	3	Receiver's bank - ISO 3166-1 numeric country code
ultimate_sender_name	N	AN	70	Ultimate sender - name.
ultimate_sender_country_iso	N	AN	3 - 3	Ultimate sender - country. ISO 3166-1 numeric country code.
ultimate_sender_organization_code	N	AN	11	Ultimate sender - organization code.
ultimate_sender_birth_date	N	AN	-	Ultimate sender - birth date. Must be valid date (Y-M-D format).
ultimate_sender_birth_city	N	AN	35	Ultimate sender - birth city.
ultimate_sender_birth_country_iso	N	AN	3 - 3	Ultimate sender - birth country. ISO 3166-1 numeric country code.
ultimate_sender_private_identifier	N	AN	35	Ultimate sender - private identifier.
ultimate_sender_private_issuer	N	AN	35	Ultimate sender - private issuer.
ultimate_sender_private_code	N	AN	4	Ultimate sender - private code.
ultimate_sender_private_proprietary	N	AN	35	Ultimate sender - private proprietary.
ultimate_sender_organization	N	AN	-	Ultimate sender - is organization. Available values - true/false.
ultimate_receiver_name	N	AN	70	Ultimate receiver - name.
ultimate_receiver_country_iso	N	AN	3 - 3	Ultimate receiver - country. ISO 3166-1 numeric country code.
ultimate_receiver_organization_code	N	AN	11	Ultimate receiver - organization code.
ultimate_receiver_birth_date	N	AN	-	Ultimate receiver - birth date. Must be valid date (Y-M-D format).
ultimate_receiver_birth_city	N	AN	35	Ultimate receiver - birth city.
ultimate_receiver_birth_country_iso	N	AN	3 - 3	Ultimate receiver - birth country. ISO 3166-1 numeric country code.
ultimate_receiver_private_identifier	N	AN	35	Ultimate receiver - private identifier.
ultimate_receiver_private_issuer	N	AN	35	Ultimate receiver - private issuer.
ultimate_receiver_private_code	N	AN	4	Ultimate receiver - private code.
ultimate_receiver_private_proprietary	N	AN	35	Ultimate receiver - private proprietary.
ultimate_receiver_organization	N	AN	-	Ultimate receiver - is organization. Available values - true/false.
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
transaction_status	Y	N	20	See IBAN transaction status.
notes	Y	AN	255
supplementary_data	N	AN		Bank provided supplementary data in JSON.
request_reference	N	AN	255	Transaction's request reference
created_at	Y	AN	25	ISO 8601
transaction_scheme	N	N	2	See IBAN transfer schemes.
transaction_type	N	N	2	See IBAN transfer types.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "transaction_id": "1166071",
   "sender_account_id": "1753154",
   "sender_iban": "GB8888888888888888",
   "sender_account_name": "John Joe",
   "receiver_iban": "GB77777777777777777",
   "receiverr_account_name": "John Doe",
   "receiver_account_number": "78726600",
   "receiver_sort_code": "660011",
   "receiver_country_iso": "004",
   "receiver_bank_name": "Barclays",
   "receiver_bank_bic": "HABALT22",
   "receiver_bank_routing_number": "",
   "receiver_bank_clearing_system_iso_code": "",
   "receiver_bank_clearing_system_member_id": "",
   "receiver_bank_country_iso": "004",
   "ultimate_sender_name": "Jones Ltd.",
   "ultimate_sender_country_iso": "004",
   "ultimate_sender_organization_code": "004",
   "ultimate_sender_birth_date": "1986-06-08",
   "ultimate_sender_birth_city": "London",
   "ultimate_sender_birth_country_iso": "004",
   "ultimate_sender_private_identifier": "ID-2345",
   "ultimate_sender_private_issuer": "IS-12345",
   "ultimate_sender_private_code": "0004",
   "ultimate_sender_private_proprietary": "Property",
   "ultimate_sender_organization": "true",
   "ultimate_receiver_name": "Anthony Ltd.",
   "ultimate_receiver_country_iso": "004",
   "ultimate_receiver_organization_code": "005",
   "ultimate_receiver_birth_date": "1977-08-08",
   "ultimate_receiver_birth_city": "London",
   "ultimate_receiver_birth_country_iso": "004",
   "ultimate_receiver_private_identifier": "ID-3555",
   "ultimate_receiver_private_issuer": "IS-333",
   "ultimate_receiver_private_code": "1111",
   "ultimate_receiver_private_proprietary": "Property",
   "ultimate_receiver_organization": "true",
   "amount": "5.00",
   "currency": "GBP",
   "transaction_status": "10",
   "notes": "Transfer from Account (1753154) to IBAN (GB77777777777777777)",
   "supplementary_data": "[{\"Name\":\"Amount\",\"Value\":\"100000.0\"},{\"Name\":\"BeneficiaryCreditInstitution\",\"Value\":\"040473\"}]",
   "request_reference": "AAA12345789",
   "created_at": "2019-12-16T13:42:39+00:00",
   "transaction_type": 1,
   "transaction_scheme": 5,
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Credit Card to Account

Request

Parameter	M	Type	Length	Description
status	Y	AN	10	success/ fail.
type	Y	AN	4
account_id	Y	N	20	Account ID.
order_id	Y	AN	13
settled_amount	Y	N	10,2
currency	Y	A	3	ISO 4217
transaction_id	Y	N	20	Unique transaction ID.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "type": "cc2a",  
   "account_id": "1753154",  
   "currency": "EUR",  
   "order_id": "1111123acb440",  
   "settled_amount": "77.01",  
   "status": "success",  
   "transaction_id": "1166071",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Crypto to Account

Request

Parameter	M	Type	Length	Description
status	Y	AN	10	success/fail.
type	Y	AN	4
account_id	Y	N	20	Account ID.
order_id	Y	AN	13
settled_amount	Y	N	10,2 / 10,(6-9)	10,2 for fiat currencies / For specific cryptocurrency length, see Crypto currency.
currency	Y	A	3	ISO 4217 For crypto currencies see Crypto currency.
transaction_id	Y	N	20	Unique transaction ID.
crypto_address	Y	AN	35
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "status": "success",
   "type": "api_btc2a",  
   "account_id": "1753154",  
   "currency": "EUR",  
   "order_id": "1111019b5f9f8",  
   "settled_amount": "100.01",    
   "transaction_id": "1166071",  
   "crypto_address": "5SA8895789555555555",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Direct credit to Account

Receive

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/direct-credit-received	POST

Request

Parameter	M	Type	Length	Description
transaction_id	Y	N	20	Unique transaction ID.
receiver_account_id	Y	N	20	Receiver's account ID.
receiver_iban	Y	AN	34	Receiver's bank account address - IBAN number
receiver_account_name	Y	A	255	Receiver's bank account address - Account name
sender_originator_id	N	N	20
sender_originator_name	N	AN	255
sender_originator_service_user_number	N	N	6	Unique reference, which identifies originator
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
reference	Y	AN	35
transaction_details	Y	AN	255
transaction_scheme	N	N	2	See IBAN transfer schemes.
transaction_type	N	N	2	See IBAN transfer types.
transaction_status	Y	N	20	See IBAN transaction status.
transaction_identifier	N	AN	100	Unique external transaction identifier.
end_to_end_identifier	N	AN	100	Transaction's end to end identifier.
created_at	Y	AN	25	ISO 8601
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
    "transaction_id": "1166071",
    "receiver_account_id": "1753242",
    "receiver_iban": "GB8888888888888888",
    "receiver_account_name": "John Joe",
    "sender_originator_id": "1753154",
    "sender_originator_name": "Originator EU",
    "sender_originator_service_user_number": "123456",
    "amount": "5.00",
    "currency": "GBP",
    "reference": "GRE547877",
    "transaction_details": "Direct credit transfer from Originator (1753154) to Account (1753242). Reference - GRE547877",
    "transaction_type": 7,
    "transaction_scheme": 2,
    "transaction_status": 3,
    "transaction_identifier": null,
    "end_to_end_identifier": null,
    "created_at": "2019-12-16T13:42:39+00:00",
    "key": "_MERCHANT_KEY_",
    "ts": "_TIMESTAMP_",
    "sign": "_SIGN_"
}

Settle

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/direct-credit-settled	POST

Request

Parameter	M	Type	Length	Description
transaction_id	Y	N	20	Unique transaction ID.
receiver_account_id	Y	N	20	Receiver's account ID.
receiver_iban	Y	AN	34	Receiver's bank account address - IBAN number
receiver_account_name	Y	A	255	Receiver's bank account address - Account name
sender_originator_id	N	N	20
sender_originator_name	N	AN	255
sender_originator_service_user_number	N	N	6	Unique reference, which identifies originator
sender_iban	N	AN	34	Sender's bank account address - IBAN number
sender_account_name	Y	A	255	Sender's bank account address - Account name
sender_account_number	N	N	26	Sender's bank account address - Account number
sender_sort_code	N	AN	6	Sender's bank account address - Sort code
sender_country_iso	N	N	3	Sender's bank account address - ISO 3166-1 numeric country code
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
reference	Y	AN	35
transaction_details	Y	AN	255
transaction_scheme	N	N	2	See IBAN transfer schemes.
transaction_type	N	N	2	See IBAN transfer types.
transaction_status	Y	N	20	See IBAN transaction status.
transaction_identifier	N	AN	100	Unique external transaction identifier.
end_to_end_identifier	N	AN	100	Transaction's end to end identifier.
created_at	Y	AN	25	ISO 8601
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
    "transaction_id": "1166071",
    "receiver_account_id": "1753154",
    "receiver_iban": "GB8888888888888888",
    "receiver_account_name": "John Joe",
    "sender_originator_id": "1753242",
    "sender_originator_name": "Originator EU",
    "sender_originator_service_user_number": "123456",
    "sender_iban": "GB77777777777777777",
    "sender_account_name": "John Doe",
    "sender_account_number": "78726600",
    "sender_sort_code": "660011",
    "sender_country_iso": "826",
    "amount": "5.00",
    "currency": "GBP",
    "reference": "GRE547877",
    "transaction_details": "Direct credit transfer from Originator (1753242) to Account (1753154). Reference - GRE547877",
    "transaction_type": 7,
    "transaction_scheme": 2,
    "transaction_status": 5,
    "transaction_identifier": "TX123456789",
    "end_to_end_identifier": "end2End134789",
    "created_at": "2019-12-16T13:42:39+00:00",
    "key": "_MERCHANT_KEY_",
    "ts": "_TIMESTAMP_",
    "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

IBAN to Account

Return Completed

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/iban-inbound-return-completed	POST

Request

Parameter	M	Type	Length	Description
transaction_id	Y	N	20	Unique transaction ID.
returned_transaction_id	Y	N	20	Unique returned transaction ID.
sender_account_id	Y	N	20	Sender's account ID.
sender_iban	Y	AN	34	Sender's bank account address - IBAN number
sender_account_name	Y	A	255	Sender's bank account address - Account name
sender_account_number	N	N	26	Sender's bank account address - Account number.
sender_sort_code	N	AN	6	Sender's bank account address - Sort code.
receiver_iban	N	AN	34	Receiver's bank account address - IBAN number
receiver_account_name	Y	A	255	Receiver's bank account address - Account name
receiver_account_number	N	N	26	Receiver's bank account address - Account number.
receiver_sort_code	N	AN	6	Receiver's bank account address - Sort code.
receiver_country_iso	N	N	3	Receiver's bank account address - ISO 3166-1 numeric country code
receiver_bank_name	N	AN	140	Receiver's bank - Name
receiver_bank_bic	N	AN	140	Receiver's bank - BIC
receiver_bank_routing_number	N	AN	35	Receiver's bank - Routing number (ABA)
receiver_bank_clearing_system_iso_code	N	AN	35	Receiver's bank - Clearing system code (ISO 20022)
receiver_bank_clearing_system_member_id	N	AN	35	Receiver's bank - Clearing system member ID
receiver_bank_country_iso	N	AN	3	Receiver's bank - ISO 3166-1 numeric country code
ultimate_sender_name	N	AN	70	Ultimate sender - name.
ultimate_sender_country_iso	N	AN	3 - 3	Ultimate sender - country. ISO 3166-1 numeric country code.
ultimate_sender_organization_code	N	AN	11	Ultimate sender - organization code.
ultimate_sender_birth_date	N	AN	-	Ultimate sender - birth date. Must be valid date (Y-M-D format).
ultimate_sender_birth_city	N	AN	35	Ultimate sender - birth city.
ultimate_sender_birth_country_iso	N	AN	3 - 3	Ultimate sender - birth country. ISO 3166-1 numeric country code.
ultimate_sender_private_identifier	N	AN	35	Ultimate sender - private identifier.
ultimate_sender_private_issuer	N	AN	35	Ultimate sender - private issuer.
ultimate_sender_private_code	N	AN	4	Ultimate sender - private code.
ultimate_sender_private_proprietary	N	AN	35	Ultimate sender - private proprietary.
ultimate_sender_organization	N	AN	-	Ultimate sender - is organization. Available values - true/false.
ultimate_receiver_name	N	AN	70	Ultimate receiver - name.
ultimate_receiver_country_iso	N	AN	3 - 3	Ultimate receiver - country. ISO 3166-1 numeric country code.
ultimate_receiver_organization_code	N	AN	11	Ultimate receiver - organization code.
ultimate_receiver_birth_date	N	AN	-	Ultimate receiver - birth date. Must be valid date (Y-M-D format).
ultimate_receiver_birth_city	N	AN	35	Ultimate receiver - birth city.
ultimate_receiver_birth_country_iso	N	AN	3 - 3	Ultimate receiver - birth country. ISO 3166-1 numeric country code.
ultimate_receiver_private_identifier	N	AN	35	Ultimate receiver - private identifier.
ultimate_receiver_private_issuer	N	AN	35	Ultimate receiver - private issuer.
ultimate_receiver_private_code	N	AN	4	Ultimate receiver - private code.
ultimate_receiver_private_proprietary	N	AN	35	Ultimate receiver - private proprietary.
ultimate_receiver_organization	N	AN	-	Ultimate receiver - is organization. Available values - true/false.
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
notes	Y	AN	255
created_at	Y	AN	25	ISO 8601
transaction_scheme	N	N	2	See IBAN transfer schemes.
transaction_type	N	N	2	See IBAN transfer types.
transaction_identifier	N	AN	100	Unique external transaction identifier.
end_to_end_identifier	N	AN	100	Transaction's end to end identifier.
reference	N	AN	35
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "transaction_id": "1166071",
   "returned_transaction_id": "1188072",
   "sender_account_id": "1753154",
   "sender_iban": "GB8888888888888888",
   "sender_account_name": "John Joe",
   "sender_account_number": null,
   "sender_sort_code": null,
   "receiver_iban": "GB77777777777777777",
   "receiver_account_name": "John Doe",
   "receiver_account_number": null,
   "receiver_sort_code": null,
   "receiver_country_iso": "004",
   "receiver_bank_name": "Barclays",
   "receiver_bank_bic": "HABALT22",
   "receiver_bank_routing_number": "",
   "receiver_bank_clearing_system_iso_code": "",
   "receiver_bank_clearing_system_member_id": "",
   "receiver_bank_country_iso": "004",
   "ultimate_sender_name": "Jones Ltd.",
   "ultimate_sender_country_iso": "004",
   "ultimate_sender_organization_code": "004",
   "ultimate_sender_birth_date": "1986-06-08",
   "ultimate_sender_birth_city": "London",
   "ultimate_sender_birth_country_iso": "004",
   "ultimate_sender_private_identifier": "ID-2345",
   "ultimate_sender_private_issuer": "IS-12345",
   "ultimate_sender_private_code": "0004",
   "ultimate_sender_private_proprietary": "Property",
   "ultimate_sender_organization": "true",
   "ultimate_receiver_name": "Anthony Ltd.",
   "ultimate_receiver_country_iso": "004",
   "ultimate_receiver_organization_code": "005",
   "ultimate_receiver_birth_date": "1977-08-08",
   "ultimate_receiver_birth_city": "London",
   "ultimate_receiver_birth_country_iso": "004",
   "ultimate_receiver_private_identifier": "ID-3555",
   "ultimate_receiver_private_issuer": "IS-333",
   "ultimate_receiver_private_code": "1111",
   "ultimate_receiver_private_proprietary": "Property",
   "ultimate_receiver_organization": "true",
   "amount": "5.00",
   "currency": "GBP",
   "notes": "Load from IBAN (GB77777777777777777) to Account (1753154) return.",
   "created_at": "2019-12-16T13:42:39+00:00",
   "transaction_type": 4,
   "transaction_scheme": 5,
   "transaction_identifier": "TX123456789",
   "end_to_end_identifier": "end2End134789",
   "reference": "GRE547877",
   "key": "_MERCHANT_KEY_",
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Return Failed

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/iban-inbound-return-failed	POST

Request

Parameter	M	Type	Length	Description
transaction_id	Y	N	20	Unique transaction ID.
returned_transaction_id	Y	N	20	Unique returned transaction ID.
sender_account_id	Y	N	20	Sender's account ID.
sender_iban	Y	AN	34	Sender's bank account address - IBAN number
sender_account_name	Y	A	255	Sender's bank account address - Account name
sender_account_number	N	N	26	Sender's bank account address - Account number.
sender_sort_code	N	AN	6	Sender's bank account address - Sort code.
receiver_iban	N	AN	34	Receiver's bank account address - IBAN number
receiver_account_name	Y	A	255	Receiver's bank account address - Account name
receiver_account_number	N	N	26	Receiver's bank account address - Account number.
receiver_sort_code	N	AN	6	Receiver's bank account address - Sort code.
receiver_country_iso	N	N	3	Receiver's bank account address - ISO 3166-1 numeric country code
receiver_bank_name	N	AN	140	Receiver's bank - Name
receiver_bank_bic	N	AN	140	Receiver's bank - BIC
receiver_bank_routing_number	N	AN	35	Receiver's bank - Routing number (ABA)
receiver_bank_clearing_system_iso_code	N	AN	35	Receiver's bank - Clearing system code (ISO 20022)
receiver_bank_clearing_system_member_id	N	AN	35	Receiver's bank - Clearing system member ID
receiver_bank_country_iso	N	AN	3	Receiver's bank - ISO 3166-1 numeric country code
ultimate_sender_name	N	AN	70	Ultimate sender - name.
ultimate_sender_country_iso	N	AN	3 - 3	Ultimate sender - country. ISO 3166-1 numeric country code.
ultimate_sender_organization_code	N	AN	11	Ultimate sender - organization code.
ultimate_sender_birth_date	N	AN	-	Ultimate sender - birth date. Must be valid date (Y-M-D format).
ultimate_sender_birth_city	N	AN	35	Ultimate sender - birth city.
ultimate_sender_birth_country_iso	N	AN	3 - 3	Ultimate sender - birth country. ISO 3166-1 numeric country code.
ultimate_sender_private_identifier	N	AN	35	Ultimate sender - private identifier.
ultimate_sender_private_issuer	N	AN	35	Ultimate sender - private issuer.
ultimate_sender_private_code	N	AN	4	Ultimate sender - private code.
ultimate_sender_private_proprietary	N	AN	35	Ultimate sender - private proprietary.
ultimate_sender_organization	N	AN	-	Ultimate sender - is organization. Available values - true/false.
ultimate_receiver_name	N	AN	70	Ultimate receiver - name.
ultimate_receiver_country_iso	N	AN	3 - 3	Ultimate receiver - country. ISO 3166-1 numeric country code.
ultimate_receiver_organization_code	N	AN	11	Ultimate receiver - organization code.
ultimate_receiver_birth_date	N	AN	-	Ultimate receiver - birth date. Must be valid date (Y-M-D format).
ultimate_receiver_birth_city	N	AN	35	Ultimate receiver - birth city.
ultimate_receiver_birth_country_iso	N	AN	3 - 3	Ultimate receiver - birth country. ISO 3166-1 numeric country code.
ultimate_receiver_private_identifier	N	AN	35	Ultimate receiver - private identifier.
ultimate_receiver_private_issuer	N	AN	35	Ultimate receiver - private issuer.
ultimate_receiver_private_code	N	AN	4	Ultimate receiver - private code.
ultimate_receiver_private_proprietary	N	AN	35	Ultimate receiver - private proprietary.
ultimate_receiver_organization	N	AN	-	Ultimate receiver - is organization. Available values - true/false.
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
notes	Y	AN	255
created_at	Y	AN	25	ISO 8601
transaction_scheme	N	N	2	See IBAN transfer schemes.
transaction_type	N	N	2	See IBAN transfer types.
transaction_identifier	N	AN	100	Unique external transaction identifier.
end_to_end_identifier	N	AN	100	Transaction's end to end identifier.
reference	N	AN	35
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "transaction_id": "1166071",
   "returned_transaction_id": "1188072",
   "sender_account_id": "1753154",
   "sender_iban": "GB8888888888888888",
   "sender_account_name": "John Joe",
   "sender_account_number": null,
   "sender_sort_code": null,
   "receiver_iban": "GB77777777777777777",
   "receiver_account_name": "John Doe",
   "receiver_account_number": null,
   "receiver_sort_code": null,
   "receiver_country_iso": "004",
   "receiver_bank_name": "Barclays",
   "receiver_bank_bic": "HABALT22",
   "receiver_bank_routing_number": "",
   "receiver_bank_clearing_system_iso_code": "",
   "receiver_bank_clearing_system_member_id": "",
   "receiver_bank_country_iso": "004",
   "ultimate_sender_name": "Jones Ltd.",
   "ultimate_sender_country_iso": "004",
   "ultimate_sender_organization_code": "004",
   "ultimate_sender_birth_date": "1986-06-08",
   "ultimate_sender_birth_city": "London",
   "ultimate_sender_birth_country_iso": "004",
   "ultimate_sender_private_identifier": "ID-2345",
   "ultimate_sender_private_issuer": "IS-12345",
   "ultimate_sender_private_code": "0004",
   "ultimate_sender_private_proprietary": "Property",
   "ultimate_sender_organization": "true",
   "ultimate_receiver_name": "Anthony Ltd.",
   "ultimate_receiver_country_iso": "004",
   "ultimate_receiver_organization_code": "005",
   "ultimate_receiver_birth_date": "1977-08-08",
   "ultimate_receiver_birth_city": "London",
   "ultimate_receiver_birth_country_iso": "004",
   "ultimate_receiver_private_identifier": "ID-3555",
   "ultimate_receiver_private_issuer": "IS-333",
   "ultimate_receiver_private_code": "1111",
   "ultimate_receiver_private_proprietary": "Property",
   "ultimate_receiver_organization": "true",
   "amount": "5.00",
   "currency": "GBP",
   "notes": "Load from IBAN (GB77777777777777777) to Account (1753154) return.",
   "created_at": "2019-12-16T13:42:39+00:00",
   "transaction_type": 4,
   "transaction_scheme": null,
   "transaction_identifier": null,
   "end_to_end_identifier": null,
   "reference": "GRE547877",
   "key": "_MERCHANT_KEY_",
   "ts": "_TIMESTAMP_",
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Return Rejected

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/iban-inbound-return-rejected	POST

Request

Parameter	M	Type	Length	Description
transaction_id	Y	N	20	Unique transaction ID.
returned_transaction_id	Y	N	20	Unique returned transaction ID.
created_at	Y	AN	25	ISO 8601
transaction_scheme	N	N	2	See IBAN transfer schemes.
transaction_type	N	N	2	See IBAN transfer types.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "transaction_id": "1166071",
   "returned_transaction_id": "1188072",
   "created_at": "2019-12-16T13:42:39+00:00",
   "transaction_type": 4,
   "transaction_scheme": 1,
   "key": "_MERCHANT_KEY_",
   "ts": "_TIMESTAMP_",
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Return Declined

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/iban-inbound-return-declined	POST

Request

Parameter	M	Type	Length	Description
transaction_id	Y	N	20	Unique transaction ID.
returned_transaction_id	Y	N	20	Unique returned transaction ID.
reason_code	Y	AN	3	See IBAN Inbound return message codes.
transaction_scheme	N	N	2	See IBAN transfer schemes.
transaction_type	N	N	2	See IBAN transfer types.
created_at	Y	AN	25	ISO 8601
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "transaction_id": "1166071",
   "returned_transaction_id": "1188072",
   "reason_code": "521",
   "created_at": "2019-12-16T13:42:39+00:00",
   "transaction_type": 4,
   "transaction_scheme": null,
   "key": "_MERCHANT_KEY_",
   "ts": "_TIMESTAMP_",
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Reverse

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/iban-inbound-reverse	POST

Request

Parameter	M	Type	Length	Description
transaction_id	Y	N	20	Unique transaction ID.
reversed_transaction_id	Y	N	20	Unique reversed transaction ID.
sender_account_id	Y	N	20	Sender's account ID.
sender_iban	N	AN	34	Sender's bank account address - IBAN number
sender_account_name	Y	A	255	Sender's bank account address - Account name
sender_account_number	N	N	26	Sender's bank account address - Account number
sender_sort_code	N	AN	6	Sender's bank account address - Sort code
receiver_iban	N	AN	34	Receiver's bank account address - IBAN number
receiver_account_name	Y	A	255	Receiver's bank account address - Account name
receiver_account_number	N	N	26	Receiver's bank account address - Account number
receiver_sort_code	N	AN	6	Receiver's bank account address - Sort code
receiver_country_iso	N	N	3	Receiver's bank account address - ISO 3166-1 numeric country code
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
transaction_status	Y	N	20	See IBAN transaction status.
notes	Y	AN	255
created_at	Y	AN	25	ISO 8601
reason_description	Y	AN	255
transaction_scheme	N	N	2	See IBAN transfer schemes.
transaction_type	N	N	2	See IBAN transfer types.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "transaction_id": "1166071",
   "reversed_transaction_id": "1188072",
   "sender_account_id": "1753154",
   "sender_iban": "GB8888888888888888",
   "sender_account_name": "John Joe",
   "sender_account_number": "78726600",
   "sender_sort_code": "660011",
   "receiver_iban": "GB77777777777777777",
   "receiver_account_name": "John Doe",
   "receiver_account_number": "78726711",
   "receiver_sort_code": "671100",
   "receiver_country_iso": "004",
   "amount": "5.00",
   "currency": "GBP",
   "transaction_status": "8",
   "notes": "Reverse of transfer from IBAN (GB77777777777777777) to Account (1753154). Reason - Request Timed out.",
   "created_at": "2019-12-16T13:42:39+00:00",
   "reason_description": "IBAN is unavailable.",
   "transaction_type": 1,
   "transaction_scheme": null,
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Settlement

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/iban-inbound-settled	POST

Request

Parameter	M	Type	Length	Description
transaction_id	Y	N	20	Unique transaction ID
receiver_account_id	Y	N	20	Receiver's account ID.
receiver_iban	N	AN	34	Receiver's bank account address - IBAN number
receiver_account_name	Y	A	255	Receiver's bank account address - Account name
receiver_account_number	N	N	26	Receiver's bank account address - Account number
receiver_sort_code	N	AN	6	Receiver's bank account address - Sort code
receiver_address	N	AN	255	Receiver's address
sender_iban	N	AN	34	Sender's bank account address - IBAN number
sender_account_name	Y	A	255	Sender's bank account address - Account name
sender_account_number	N	N	26	Sender's bank account address - Account number
sender_sort_code	N	AN	6	Sender's bank account address - Sort code
sender_country_iso	N	N	3	Sender's bank account address - ISO 3166-1 numeric country code
sender_address	N	AN	255	Senders's address
ultimate_sender_name	N	AN	70	Ultimate sender - name.
ultimate_sender_country_iso	N	AN	3 - 3	Ultimate sender - country. ISO 3166-1 numeric country code.
ultimate_sender_organization_code	N	AN	11	Ultimate sender - organization code.
ultimate_sender_birth_date	N	AN	-	Ultimate sender - birth date. Must be valid date (Y-M-D format).
ultimate_sender_birth_city	N	AN	35	Ultimate sender - birth city.
ultimate_sender_birth_country_iso	N	AN	3 - 3	Ultimate sender - birth country. ISO 3166-1 numeric country code.
ultimate_sender_private_identifier	N	AN	35	Ultimate sender - private identifier.
ultimate_sender_private_issuer	N	AN	35	Ultimate sender - private issuer.
ultimate_sender_private_code	N	AN	4	Ultimate sender - private code.
ultimate_sender_private_proprietary	N	AN	35	Ultimate sender - private proprietary.
ultimate_sender_organization	N	AN	-	Ultimate sender - is organization. Available values - true/false.
ultimate_receiver_name	N	AN	70	Ultimate receiver - name.
ultimate_receiver_country_iso	N	AN	3 - 3	Ultimate receiver - country. ISO 3166-1 numeric country code.
ultimate_receiver_organization_code	N	AN	11	Ultimate receiver - organization code.
ultimate_receiver_birth_date	N	AN	-	Ultimate receiver - birth date. Must be valid date (Y-M-D format).
ultimate_receiver_birth_city	N	AN	35	Ultimate receiver - birth city.
ultimate_receiver_birth_country_iso	N	AN	3 - 3	Ultimate receiver - birth country. ISO 3166-1 numeric country code.
ultimate_receiver_private_identifier	N	AN	35	Ultimate receiver - private identifier.
ultimate_receiver_private_issuer	N	AN	35	Ultimate receiver - private issuer.
ultimate_receiver_private_code	N	AN	4	Ultimate receiver - private code.
ultimate_receiver_private_proprietary	N	AN	35	Ultimate receiver - private proprietary.
ultimate_receiver_organization	N	AN	-	Ultimate receiver - is organization. Available values - true/false.
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
transaction_status	Y	N	20	See IBAN transaction status.
notes	Y	AN	255
supplementary_data	N	AN		Bank provided supplementary data in JSON.
iso20022_xml_document	N	AN	0 - 80000	Bank provided CHAPS ISO20022 message in XML.
additional_note	N	AN	255	Additional sender's note.
purpose_code	N	AN	4	ISO 20022 external code.
purpose_description	N	AN	255
reference	N	AN	255	Reference of transaction
created_at	Y	AN	25	ISO 8601
transaction_scheme	N	N	2	See IBAN transfer schemes.
transaction_type	N	N	2	See IBAN transfer types.
transaction_identifier	N	AN	100	Unique external transaction identifier.
end_to_end_identifier	N	AN	100	Transaction's end to end identifier.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
  "transaction_id": "1166071",
  "receiver_account_id": "1753154",
  "receiver_iban": "GB8888888888888888",
  "receiver_account_name": "John Joe",
  "receiver_account_number": "78726600",
  "receiver_sort_code": "660011",
  "receiver_address": "Street name 1",
  "sender_iban": "GB77777777777777777",
  "sender_account_name": "John Joe",
  "sender_account_number": "78726711",
  "sender_sort_code": "671100",
  "sender_country_iso": "004",
  "sender_address": "Street name 1",
  "ultimate_sender_name": "Jones Ltd.",
  "ultimate_sender_country_iso": "004",
  "ultimate_sender_organization_code": "004",
  "ultimate_sender_birth_date": "1986-06-08",
  "ultimate_sender_birth_city": "London",
  "ultimate_sender_birth_country_iso": "004",
  "ultimate_sender_private_identifier": "ID-2345",
  "ultimate_sender_private_issuer": "IS-12345",
  "ultimate_sender_private_code": "0004",
  "ultimate_sender_private_proprietary": "Property",
  "ultimate_sender_organization": "true",
  "ultimate_receiver_name": "Anthony Ltd.",
  "ultimate_receiver_country_iso": "004",
  "ultimate_receiver_organization_code": "005",
  "ultimate_receiver_birth_date": "1977-08-08",
  "ultimate_receiver_birth_city": "London",
  "ultimate_receiver_birth_country_iso": "004",
  "ultimate_receiver_private_identifier": "ID-3555",
  "ultimate_receiver_private_issuer": "IS-333",
  "ultimate_receiver_private_code": "1111",
  "ultimate_receiver_private_proprietary": "Property",
  "ultimate_receiver_organization": "true",
  "amount": "5.00",
  "currency": "GBP",
  "transaction_status": "5",
  "notes": "Load from IBAN (GB77777777777777777) to Account (1753154). Reference - new reference.",
  "supplementary_data": "[{\"Name\":\"Amount\",\"Value\":\"100000.0\"},{\"Name\":\"BeneficiaryCreditInstitution\",\"Value\":\"040473\"}]",
  "iso20022_xml_document": "<Document xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns=\"urn:iso:std:iso:20022:tech:xsd:pacs.008.001.08\"><FIToFICstmrCdtTrf><GrpHdr><CreDtTm>1900-02-03T04:00:30+00:00</CreDtTm><NbOfTxs>1</NbOfTxs></GrpHdr><CdtTrfTxInf><PmtId><InstrId>Id12</InstrId><EndToEndId>EndId21</EndToEndId><UETR>d9bd8c6e-e1d9-405b-ac53-2fa197149d09</UETR></PmtId><IntrBkSttlmAmt Ccy=\"Eur\">1.01</IntrBkSttlmAmt><IntrBkSttlmDt>1900-11-01</IntrBkSttlmDt><ChrgBr>DEBT</ChrgBr><Dbtr><Nm>ExampleName</Nm></Dbtr><DbtrAcct><Id><IBAN>GB00AABB00001111000111</IBAN></Id></DbtrAcct><DbtrAgt><FinInstnId><BICFI>LLAABB11XXX</BICFI></FinInstnId></DbtrAgt><CdtrAgt><FinInstnId><BICFI>LLAABB11XXX</BICFI></FinInstnId></CdtrAgt><CdtrAcct><Id><IBAN>GB00AABB00001111000112</IBAN></Id></CdtrAcct><RmtInf><Ustrd>ExampleReference1</Ustrd></RmtInf></CdtTrfTxInf></FIToFICstmrCdtTrf></Document>",
  "additional_note":"Sender's note.",
  "purpose_code": "PTXP",
  "purpose_description": "Property Tax",
  "reference": "ABC123456",
  "created_at": "2019-12-16T13:42:39+00:00",
  "transaction_type": 1,
  "transaction_scheme": 1,
  "transaction_identifier": "TX123456789",
  "end_to_end_identifier": "end2End134789",
  "key": "_MERCHANT_KEY_",
  "ts": "_TIMESTAMP_",
  "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Settlement with return

This webhook is for cases when a third party initiates the inbound return. Make sure to check inbound and return transactions existing by their transaction IDs.

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/iban-inbound-settled-with-return	POST

Request

Parameter	M	Type	Length	Description
return_transaction_id	Y	N	20	Unique return transaction ID
return_reason	Y	N	3	Return reason.
return_reason_code	Y	N	3	See IBAN Inbound return message codes
transaction_id	Y	N	20	Unique transaction ID
receiver_account_id	Y	N	20	Settled transaction's info. Receiver's account ID.
receiver_iban	Y	AN	34	Settled transaction's info. Receiver's bank account address - IBAN number
receiver_account_name	Y	A	255	Settled transaction's info. Receiver's bank account address - Account name
receiver_account_number	N	N	26	Settled transaction's info. Receiver's bank account address - Account number
receiver_sort_code	N	AN	6	Settled transaction's info. Receiver's bank account address - Sort code
receiver_address	N	AN	255	Settled transaction's info. Receiver's address
receiver_bank_name	N	AN	140	Receiver's bank - Name
receiver_bank_bic	N	AN	140	Receiver's bank - BIC
receiver_bank_routing_number	N	AN	35	Receiver's bank - Routing number (ABA)
receiver_bank_clearing_system_iso_code	N	AN	35	Receiver's bank - Clearing system code (ISO 20022)
receiver_bank_clearing_system_member_id	N	AN	35	Receiver's bank - Clearing system member ID
receiver_bank_country_iso	N	AN	3	Receiver's bank - ISO 3166-1 numeric country code
sender_iban	N	AN	34	Settled transaction's info. Sender's bank account address - IBAN number
sender_account_name	Y	A	255	Settled transaction's info. Sender's bank account address - Account name
sender_account_number	N	N	26	Settled transaction's info. Sender's bank account address - Account number
sender_sort_code	N	AN	6	Settled transaction's info. Sender's bank account address - Sort code
sender_country_iso	N	N	3	Settled transaction's info. Sender's bank account address - ISO 3166-1 numeric country code
sender_address	N	AN	255	Settled transaction's info. Senders's address
ultimate_sender_name	N	AN	70	Ultimate sender - name.
ultimate_sender_country_iso	N	AN	3 - 3	Ultimate sender - country. ISO 3166-1 numeric country code.
ultimate_sender_organization_code	N	AN	11	Ultimate sender - organization code.
ultimate_sender_birth_date	N	AN	-	Ultimate sender - birth date. Must be valid date (Y-M-D format).
ultimate_sender_birth_city	N	AN	35	Ultimate sender - birth city.
ultimate_sender_birth_country_iso	N	AN	3 - 3	Ultimate sender - birth country. ISO 3166-1 numeric country code.
ultimate_sender_private_identifier	N	AN	35	Ultimate sender - private identifier.
ultimate_sender_private_issuer	N	AN	35	Ultimate sender - private issuer.
ultimate_sender_private_code	N	AN	4	Ultimate sender - private code.
ultimate_sender_private_proprietary	N	AN	35	Ultimate sender - private proprietary.
ultimate_sender_organization	N	AN	-	Ultimate sender - is organization. Available values - true/false.
ultimate_receiver_name	N	AN	70	Ultimate receiver - name.
ultimate_receiver_country_iso	N	AN	3 - 3	Ultimate receiver - country. ISO 3166-1 numeric country code.
ultimate_receiver_organization_code	N	AN	11	Ultimate receiver - organization code.
ultimate_receiver_birth_date	N	AN	-	Ultimate receiver - birth date. Must be valid date (Y-M-D format).
ultimate_receiver_birth_city	N	AN	35	Ultimate receiver - birth city.
ultimate_receiver_birth_country_iso	N	AN	3 - 3	Ultimate receiver - birth country. ISO 3166-1 numeric country code.
ultimate_receiver_private_identifier	N	AN	35	Ultimate receiver - private identifier.
ultimate_receiver_private_issuer	N	AN	35	Ultimate receiver - private issuer.
ultimate_receiver_private_code	N	AN	4	Ultimate receiver - private code.
ultimate_receiver_private_proprietary	N	AN	35	Ultimate receiver - private proprietary.
ultimate_receiver_organization	N	AN	-	Ultimate receiver - is organization. Available values - true/false.
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
transaction_status	Y	N	20	See IBAN transaction status.
notes	Y	AN	255
supplementary_data	N	AN		Bank provided supplementary data in JSON.
iso20022_xml_document	N	AN	0 - 80000	Bank provided CHAPS ISO20022 message in XML.
additional_note	N	AN	255	Additional sender's note.
purpose_code	N	AN	4	ISO 20022 external code.
purpose_description	N	AN	255
reference	N	AN	255	Settled transaction's info. Reference of transaction
created_at	Y	AN	25	ISO 8601
transaction_scheme	N	N	2	See IBAN transfer schemes.
transaction_type	N	N	2	See IBAN transfer types.
transaction_identifier	N	AN	100	Unique external transaction identifier.
end_to_end_identifier	N	AN	100	Transaction's end to end identifier.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "return_transaction_id": "1188072",
   "return_reason":"Regulatory reason",
   "return_reason_code":"663",
   "transaction_id": "1166071",
   "receiver_account_id": "1753154",
   "receiver_iban": "GB8888888888888888",
   "receiver_account_name": "John Joe",
   "receiver_account_number": "78726600",
   "receiver_sort_code": "660011",
   "receiver_address": "Street name 1",
   "receiver_bank_name": "Barclays",
   "receiver_bank_bic": "HABALT22",
   "receiver_bank_routing_number": "",
   "receiver_bank_clearing_system_iso_code": "",
   "receiver_bank_clearing_system_member_id": "",
   "receiver_bank_country_iso": "004",
   "sender_iban": "GB77777777777777777",
   "sender_account_name": "John Doe",
   "sender_account_number": "78726711",
   "sender_sort_code": "671100",
   "sender_country_iso": "004",
   "sender_address": "Street name 1",
   "ultimate_sender_name": "Jones Ltd.",
   "ultimate_sender_country_iso": "004",
   "ultimate_sender_organization_code": "004",
   "ultimate_sender_birth_date": "1986-06-08",
   "ultimate_sender_birth_city": "London",
   "ultimate_sender_birth_country_iso": "004",
   "ultimate_sender_private_identifier": "ID-2345",
   "ultimate_sender_private_issuer": "IS-12345",
   "ultimate_sender_private_code": "0004",
   "ultimate_sender_private_proprietary": "Property",
   "ultimate_sender_organization": "true",
   "ultimate_receiver_name": "Anthony Ltd.",
   "ultimate_receiver_country_iso": "004",
   "ultimate_receiver_organization_code": "005",
   "ultimate_receiver_birth_date": "1977-08-08",
   "ultimate_receiver_birth_city": "London",
   "ultimate_receiver_birth_country_iso": "004",
   "ultimate_receiver_private_identifier": "ID-3555",
   "ultimate_receiver_private_issuer": "IS-333",
   "ultimate_receiver_private_code": "1111",
   "ultimate_receiver_private_proprietary": "Property",
   "ultimate_receiver_organization": "true",
   "amount": "5.00",
   "currency": "GBP",
   "transaction_status": "5",
   "notes": "Load from IBAN (GB77777777777777777) to Account (1753154). Reference - new reference.",
   "supplementary_data": "[{\"Name\":\"Amount\",\"Value\":\"100000.0\"},{\"Name\":\"BeneficiaryCreditInstitution\",\"Value\":\"040473\"}]",
   "iso20022_xml_document": "<Document xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns=\"urn:iso:std:iso:20022:tech:xsd:pacs.008.001.08\"><FIToFICstmrCdtTrf><GrpHdr><CreDtTm>1900-02-03T04:00:30+00:00</CreDtTm><NbOfTxs>1</NbOfTxs></GrpHdr><CdtTrfTxInf><PmtId><InstrId>Id12</InstrId><EndToEndId>EndId21</EndToEndId><UETR>d9bd8c6e-e1d9-405b-ac53-2fa197149d09</UETR></PmtId><IntrBkSttlmAmt Ccy=\"Eur\">1.01</IntrBkSttlmAmt><IntrBkSttlmDt>1900-11-01</IntrBkSttlmDt><ChrgBr>DEBT</ChrgBr><Dbtr><Nm>ExampleName</Nm></Dbtr><DbtrAcct><Id><IBAN>GB00AABB00001111000111</IBAN></Id></DbtrAcct><DbtrAgt><FinInstnId><BICFI>LLAABB11XXX</BICFI></FinInstnId></DbtrAgt><CdtrAgt><FinInstnId><BICFI>LLAABB11XXX</BICFI></FinInstnId></CdtrAgt><CdtrAcct><Id><IBAN>GB00AABB00001111000112</IBAN></Id></CdtrAcct><RmtInf><Ustrd>ExampleReference1</Ustrd></RmtInf></CdtTrfTxInf></FIToFICstmrCdtTrf></Document>",
   "additional_note":"Sender's note.",
   "purpose_code": "PTXP",
   "purpose_description": "Property Tax",
   "reference": "ABC123456",
   "created_at": "2019-12-16T13:42:39+00:00",
   "transaction_type": 1,
   "transaction_scheme": 1,
   "transaction_identifier": "TX123456789",
   "end_to_end_identifier": "end2End134789",
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Held

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/iban-inbound-held	POST

Request

Parameter	M	Type	Length	Description
transaction_id	Y	N	20	Unique transaction ID
receiver_account_id	Y	N	20	Receiver's account ID.
receiver_iban	N	AN	34	Receiver's bank account address - IBAN number
receiver_account_name	Y	A	255	Receiver's bank account address - Account name
receiver_account_number	N	N	26	Receiver's bank account address - Account number
receiver_sort_code	N	AN	6	Receiver's bank account address - Sort code
receiver_address	N	AN	255	Receiver's address
sender_iban	N	AN	34	Sender's bank account address - IBAN number
sender_account_name	Y	A	255	Sender's bank account address - Account name
sender_account_number	N	N	26	Sender's bank account address - Account number
sender_sort_code	N	AN	6	Sender's bank account address - Sort code
sender_country_iso	N	N	3	Sender's bank account address - ISO 3166-1 numeric country code
sender_address	N	AN	255	Senders's address
ultimate_sender_name	N	AN	70	Ultimate sender - name.
ultimate_sender_country_iso	N	AN	3 - 3	Ultimate sender - country. ISO 3166-1 numeric country code.
ultimate_sender_organization_code	N	AN	11	Ultimate sender - organization code.
ultimate_sender_birth_date	N	AN	-	Ultimate sender - birth date. Must be valid date (Y-M-D format).
ultimate_sender_birth_city	N	AN	35	Ultimate sender - birth city.
ultimate_sender_birth_country_iso	N	AN	3 - 3	Ultimate sender - birth country. ISO 3166-1 numeric country code.
ultimate_sender_private_identifier	N	AN	35	Ultimate sender - private identifier.
ultimate_sender_private_issuer	N	AN	35	Ultimate sender - private issuer.
ultimate_sender_private_code	N	AN	4	Ultimate sender - private code.
ultimate_sender_private_proprietary	N	AN	35	Ultimate sender - private proprietary.
ultimate_sender_organization	N	AN	-	Ultimate sender - is organization. Available values - true/false.
ultimate_receiver_name	N	AN	70	Ultimate receiver - name.
ultimate_receiver_country_iso	N	AN	3 - 3	Ultimate receiver - country. ISO 3166-1 numeric country code.
ultimate_receiver_organization_code	N	AN	11	Ultimate receiver - organization code.
ultimate_receiver_birth_date	N	AN	-	Ultimate receiver - birth date. Must be valid date (Y-M-D format).
ultimate_receiver_birth_city	N	AN	35	Ultimate receiver - birth city.
ultimate_receiver_birth_country_iso	N	AN	3 - 3	Ultimate receiver - birth country. ISO 3166-1 numeric country code.
ultimate_receiver_private_identifier	N	AN	35	Ultimate receiver - private identifier.
ultimate_receiver_private_issuer	N	AN	35	Ultimate receiver - private issuer.
ultimate_receiver_private_code	N	AN	4	Ultimate receiver - private code.
ultimate_receiver_private_proprietary	N	AN	35	Ultimate receiver - private proprietary.
ultimate_receiver_organization	N	AN	-	Ultimate receiver - is organization. Available values - true/false.
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
transaction_status	Y	N	20	See IBAN transaction status.
notes	Y	AN	255
supplementary_data	N	AN		Bank provided supplementary data in JSON.
iso20022_xml_document	N	AN	0 - 80000	Bank provided CHAPS ISO20022 message in XML.
additional_note	N	AN	255	Additional sender's note.
purpose_code	N	AN	4	ISO 20022 external code.
purpose_description	N	AN	255
reference	N	AN	255	Reference of transaction
created_at	Y	AN	25	ISO 8601
transaction_scheme	N	N	2	See IBAN transfer schemes.
transaction_type	N	N	2	See IBAN transfer types.
transaction_identifier	N	AN	100	Unique external transaction identifier.
end_to_end_identifier	N	AN	100	Transaction's end to end identifier.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
  "transaction_id": "1166071",
  "receiver_account_id": "1753154",
  "receiver_iban": "GB8888888888888888",
  "receiver_account_name": "John Joe",
  "receiver_account_number": "78726600",
  "receiver_sort_code": "660011",
  "receiver_address": "Street name 1",
  "sender_iban": "GB77777777777777777",
  "sender_account_name": "John Joe",
  "sender_account_number": "78726711",
  "sender_sort_code": "671100",
  "sender_country_iso": "004",
  "sender_address": "Street name 1",
  "ultimate_sender_name": "Jones Ltd.",
  "ultimate_sender_country_iso": "004",
  "ultimate_sender_organization_code": "004",
  "ultimate_sender_birth_date": "1986-06-08",
  "ultimate_sender_birth_city": "London",
  "ultimate_sender_birth_country_iso": "004",
  "ultimate_sender_private_identifier": "ID-2345",
  "ultimate_sender_private_issuer": "IS-12345",
  "ultimate_sender_private_code": "0004",
  "ultimate_sender_private_proprietary": "Property",
  "ultimate_sender_organization": "true",
  "ultimate_receiver_name": "Anthony Ltd.",
  "ultimate_receiver_country_iso": "004",
  "ultimate_receiver_organization_code": "005",
  "ultimate_receiver_birth_date": "1977-08-08",
  "ultimate_receiver_birth_city": "London",
  "ultimate_receiver_birth_country_iso": "004",
  "ultimate_receiver_private_identifier": "ID-3555",
  "ultimate_receiver_private_issuer": "IS-333",
  "ultimate_receiver_private_code": "1111",
  "ultimate_receiver_private_proprietary": "Property",
  "ultimate_receiver_organization": "true",
  "amount": "5.00",
  "currency": "GBP",
  "transaction_status": "10",
  "notes": "Load from IBAN (GB77777777777777777) to Account (1753154). Reference - new reference.",
  "supplementary_data": "[{\"Name\":\"Amount\",\"Value\":\"100000.0\"},{\"Name\":\"BeneficiaryCreditInstitution\",\"Value\":\"040473\"}]",
  "iso20022_xml_document": "<Document xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns=\"urn:iso:std:iso:20022:tech:xsd:pacs.008.001.08\"><FIToFICstmrCdtTrf><GrpHdr><CreDtTm>1900-02-03T04:00:30+00:00</CreDtTm><NbOfTxs>1</NbOfTxs></GrpHdr><CdtTrfTxInf><PmtId><InstrId>Id12</InstrId><EndToEndId>EndId21</EndToEndId><UETR>d9bd8c6e-e1d9-405b-ac53-2fa197149d09</UETR></PmtId><IntrBkSttlmAmt Ccy=\"Eur\">1.01</IntrBkSttlmAmt><IntrBkSttlmDt>1900-11-01</IntrBkSttlmDt><ChrgBr>DEBT</ChrgBr><Dbtr><Nm>ExampleName</Nm></Dbtr><DbtrAcct><Id><IBAN>GB00AABB00001111000111</IBAN></Id></DbtrAcct><DbtrAgt><FinInstnId><BICFI>LLAABB11XXX</BICFI></FinInstnId></DbtrAgt><CdtrAgt><FinInstnId><BICFI>LLAABB11XXX</BICFI></FinInstnId></CdtrAgt><CdtrAcct><Id><IBAN>GB00AABB00001111000112</IBAN></Id></CdtrAcct><RmtInf><Ustrd>ExampleReference1</Ustrd></RmtInf></CdtTrfTxInf></FIToFICstmrCdtTrf></Document>",
  "additional_note":"Sender's note.",
  "purpose_code": "PTXP",
  "purpose_description": "Property Tax",
  "reference": "ABC123456",
  "created_at": "2019-12-16T13:42:39+00:00",
  "transaction_type": 1,
  "transaction_scheme": 5,
  "transaction_identifier": "TX123456789",
  "end_to_end_identifier": "end2End134789",
  "key": "_MERCHANT_KEY_",
  "ts": "_TIMESTAMP_",
  "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Held Rejected

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/iban-inbound-held-rejected	POST

Request

Parameter	M	Type	Length	Description
transaction_id	Y	N	20	Unique transaction ID
receiver_account_id	Y	N	20	Receiver's account ID.
receiver_iban	N	AN	34	Receiver's bank account address - IBAN number
receiver_account_name	Y	A	255	Receiver's bank account address - Account name
receiver_account_number	N	N	26	Receiver's bank account address - Account number
receiver_sort_code	N	AN	6	Receiver's bank account address - Sort code
receiver_address	N	AN	255	Receiver's address
sender_iban	N	AN	34	Sender's bank account address - IBAN number
sender_account_name	Y	A	255	Sender's bank account address - Account name
sender_account_number	N	N	26	Sender's bank account address - Account number
sender_sort_code	N	AN	6	Sender's bank account address - Sort code
sender_country_iso	N	N	3	Sender's bank account address - ISO 3166-1 numeric country code
sender_address	N	AN	255	Senders's address
ultimate_sender_name	N	AN	70	Ultimate sender - name.
ultimate_sender_country_iso	N	AN	3 - 3	Ultimate sender - country. ISO 3166-1 numeric country code.
ultimate_sender_organization_code	N	AN	11	Ultimate sender - organization code.
ultimate_sender_birth_date	N	AN	-	Ultimate sender - birth date. Must be valid date (Y-M-D format).
ultimate_sender_birth_city	N	AN	35	Ultimate sender - birth city.
ultimate_sender_birth_country_iso	N	AN	3 - 3	Ultimate sender - birth country. ISO 3166-1 numeric country code.
ultimate_sender_private_identifier	N	AN	35	Ultimate sender - private identifier.
ultimate_sender_private_issuer	N	AN	35	Ultimate sender - private issuer.
ultimate_sender_private_code	N	AN	4	Ultimate sender - private code.
ultimate_sender_private_proprietary	N	AN	35	Ultimate sender - private proprietary.
ultimate_sender_organization	N	AN	-	Ultimate sender - is organization. Available values - true/false.
ultimate_receiver_name	N	AN	70	Ultimate receiver - name.
ultimate_receiver_country_iso	N	AN	3 - 3	Ultimate receiver - country. ISO 3166-1 numeric country code.
ultimate_receiver_organization_code	N	AN	11	Ultimate receiver - organization code.
ultimate_receiver_birth_date	N	AN	-	Ultimate receiver - birth date. Must be valid date (Y-M-D format).
ultimate_receiver_birth_city	N	AN	35	Ultimate receiver - birth city.
ultimate_receiver_birth_country_iso	N	AN	3 - 3	Ultimate receiver - birth country. ISO 3166-1 numeric country code.
ultimate_receiver_private_identifier	N	AN	35	Ultimate receiver - private identifier.
ultimate_receiver_private_issuer	N	AN	35	Ultimate receiver - private issuer.
ultimate_receiver_private_code	N	AN	4	Ultimate receiver - private code.
ultimate_receiver_private_proprietary	N	AN	35	Ultimate receiver - private proprietary.
ultimate_receiver_organization	N	AN	-	Ultimate receiver - is organization. Available values - true/false.
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
transaction_status	Y	N	20	See IBAN transaction status.
notes	Y	AN	255
supplementary_data	N	AN		Bank provided supplementary data in JSON.
iso20022_xml_document	N	AN	0 - 80000	Bank provided CHAPS ISO20022 message in XML.
additional_note	N	AN	255	Additional sender's note.
purpose_code	N	AN	4	ISO 20022 external code.
purpose_description	N	AN	255
reference	N	AN	255	Reference of transaction
created_at	Y	AN	25	ISO 8601
transaction_scheme	N	N	2	See IBAN transfer schemes.
transaction_type	N	N	2	See IBAN transfer types.
transaction_identifier	N	AN	100	Unique external transaction identifier.
end_to_end_identifier	N	AN	100	Transaction's end to end identifier.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
  "transaction_id": "1166071",
  "receiver_account_id": "1753154",
  "receiver_iban": "GB8888888888888888",
  "receiver_account_name": "John Joe",
  "receiver_account_number": "78726600",
  "receiver_sort_code": "660011",
  "receiver_address": "Street name 1",
  "sender_iban": "GB77777777777777777",
  "sender_account_name": "John Joe",
  "sender_account_number": "78726711",
  "sender_sort_code": "671100",
  "sender_country_iso": "004",
  "sender_address": "Street name 1",
  "ultimate_sender_name": "Jones Ltd.",
  "ultimate_sender_country_iso": "004",
  "ultimate_sender_organization_code": "004",
  "ultimate_sender_birth_date": "1986-06-08",
  "ultimate_sender_birth_city": "London",
  "ultimate_sender_birth_country_iso": "004",
  "ultimate_sender_private_identifier": "ID-2345",
  "ultimate_sender_private_issuer": "IS-12345",
  "ultimate_sender_private_code": "0004",
  "ultimate_sender_private_proprietary": "Property",
  "ultimate_sender_organization": "true",
  "ultimate_receiver_name": "Anthony Ltd.",
  "ultimate_receiver_country_iso": "004",
  "ultimate_receiver_organization_code": "005",
  "ultimate_receiver_birth_date": "1977-08-08",
  "ultimate_receiver_birth_city": "London",
  "ultimate_receiver_birth_country_iso": "004",
  "ultimate_receiver_private_identifier": "ID-3555",
  "ultimate_receiver_private_issuer": "IS-333",
  "ultimate_receiver_private_code": "1111",
  "ultimate_receiver_private_proprietary": "Property",
  "ultimate_receiver_organization": "true",
  "amount": "5.00",
  "currency": "GBP",
  "transaction_status": "6",
  "notes": "Load from IBAN (GB77777777777777777) to Account (1753154). Reference - new reference.",
  "supplementary_data": "[{\"Name\":\"Amount\",\"Value\":\"100000.0\"},{\"Name\":\"BeneficiaryCreditInstitution\",\"Value\":\"040473\"}]",
  "iso20022_xml_document": "<Document xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns=\"urn:iso:std:iso:20022:tech:xsd:pacs.008.001.08\"><FIToFICstmrCdtTrf><GrpHdr><CreDtTm>1900-02-03T04:00:30+00:00</CreDtTm><NbOfTxs>1</NbOfTxs></GrpHdr><CdtTrfTxInf><PmtId><InstrId>Id12</InstrId><EndToEndId>EndId21</EndToEndId><UETR>d9bd8c6e-e1d9-405b-ac53-2fa197149d09</UETR></PmtId><IntrBkSttlmAmt Ccy=\"Eur\">1.01</IntrBkSttlmAmt><IntrBkSttlmDt>1900-11-01</IntrBkSttlmDt><ChrgBr>DEBT</ChrgBr><Dbtr><Nm>ExampleName</Nm></Dbtr><DbtrAcct><Id><IBAN>GB00AABB00001111000111</IBAN></Id></DbtrAcct><DbtrAgt><FinInstnId><BICFI>LLAABB11XXX</BICFI></FinInstnId></DbtrAgt><CdtrAgt><FinInstnId><BICFI>LLAABB11XXX</BICFI></FinInstnId></CdtrAgt><CdtrAcct><Id><IBAN>GB00AABB00001111000112</IBAN></Id></CdtrAcct><RmtInf><Ustrd>ExampleReference1</Ustrd></RmtInf></CdtTrfTxInf></FIToFICstmrCdtTrf></Document>",
  "additional_note":"Sender's note.",
  "purpose_code": "PTXP",
  "purpose_description": "Property Tax",
  "reference": "ABC123456",
  "created_at": "2019-12-16T13:42:39+00:00",
  "transaction_type": 1,
  "transaction_scheme": 5,
  "transaction_identifier": "TX123456789",
  "end_to_end_identifier": "end2End134789",
  "key": "_MERCHANT_KEY_",
  "ts": "_TIMESTAMP_",
  "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

IBAN transaction reversed

URL	Method
%YOUR_REGISTERED_MERCHANT_URL%/iban-transaction-reversed	POST

Request

Parameter	M	Type	Length	Description
reversed_transaction_id	Y	N	20	Unique reversed transaction ID.
reason_code	Y	AN	3	See IBAN Outbound return message codes.
reason_description	Y	AN	255
transaction_id	Y	N	20	Unique reverse transaction ID
receiver_account_id	Y	N	20	Receiver's account ID.
receiver_iban	N	AN	34	Receiver's bank account address - IBAN number
receiver_account_name	Y	A	255	Receiver's bank account address - Account name
receiver_account_number	N	N	26	Receiver's bank account address - Account number
receiver_sort_code	N	AN	6	Receiver's bank account address - Sort code
receiver_address	N	AN	255	Receiver's address
sender_iban	N	AN	34	Sender's bank account address - IBAN number
sender_account_name	Y	A	255	Sender's bank account address - Account name
sender_account_number	N	N	26	Sender's bank account address - Account number
sender_sort_code	N	AN	6	Sender's bank account address - Sort code
sender_country_iso	N	N	3	Sender's bank account address - ISO 3166-1 numeric country code
sender_address	N	AN	255	Senders's address
ultimate_sender_name	N	AN	70	Ultimate sender - name.
ultimate_sender_country_iso	N	AN	3 - 3	Ultimate sender - country. ISO 3166-1 numeric country code.
ultimate_sender_organization_code	N	AN	11	Ultimate sender - organization code.
ultimate_sender_birth_date	N	AN	-	Ultimate sender - birth date. Must be valid date (Y-M-D format).
ultimate_sender_birth_city	N	AN	35	Ultimate sender - birth city.
ultimate_sender_birth_country_iso	N	AN	3 - 3	Ultimate sender - birth country. ISO 3166-1 numeric country code.
ultimate_sender_private_identifier	N	AN	35	Ultimate sender - private identifier.
ultimate_sender_private_issuer	N	AN	35	Ultimate sender - private issuer.
ultimate_sender_private_code	N	AN	4	Ultimate sender - private code.
ultimate_sender_private_proprietary	N	AN	35	Ultimate sender - private proprietary.
ultimate_sender_organization	N	AN	-	Ultimate sender - is organization. Available values - true/false.
ultimate_receiver_name	N	AN	70	Ultimate receiver - name.
ultimate_receiver_country_iso	N	AN	3 - 3	Ultimate receiver - country. ISO 3166-1 numeric country code.
ultimate_receiver_organization_code	N	AN	11	Ultimate receiver - organization code.
ultimate_receiver_birth_date	N	AN	-	Ultimate receiver - birth date. Must be valid date (Y-M-D format).
ultimate_receiver_birth_city	N	AN	35	Ultimate receiver - birth city.
ultimate_receiver_birth_country_iso	N	AN	3 - 3	Ultimate receiver - birth country. ISO 3166-1 numeric country code.
ultimate_receiver_private_identifier	N	AN	35	Ultimate receiver - private identifier.
ultimate_receiver_private_issuer	N	AN	35	Ultimate receiver - private issuer.
ultimate_receiver_private_code	N	AN	4	Ultimate receiver - private code.
ultimate_receiver_private_proprietary	N	AN	35	Ultimate receiver - private proprietary.
ultimate_receiver_organization	N	AN	-	Ultimate receiver - is organization. Available values - true/false.
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
transaction_status	Y	N	20	See IBAN transaction status.
notes	Y	AN	255
supplementary_data	N	AN		Bank provided supplementary data in JSON.
iso20022_xml_document	N	AN	0 - 80000	Bank provided CHAPS ISO20022 message in XML.
additional_note	N	AN	255	Additional sender's note.
purpose_code	N	AN	4	ISO 20022 external code.
purpose_description	N	AN	255
reference	N	AN	255	Reference of transaction
created_at	Y	AN	25	ISO 8601
transaction_scheme	N	N	2	See IBAN transfer schemes.
transaction_type	N	N	2	See IBAN transfer types.
transaction_identifier	N	AN	100	Unique external transaction identifier.
end_to_end_identifier	N	AN	100	Transaction's end to end identifier.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
  "reversed_transaction_id": 1188072,
  "reason_code": "651",
  "reason_description": "Account blocked",
  "transaction_id": "1166071",
  "receiver_account_id": "1753154",
  "receiver_iban": "GB8888888888888888",
  "receiver_account_name": "John Joe",
  "receiver_account_number": "78726600",
  "receiver_sort_code": "660011",
  "receiver_address": "Street name 1",
  "sender_iban": "GB77777777777777777",
  "sender_account_name": "John Joe",
  "sender_account_number": "78726711",
  "sender_sort_code": "671100",
  "sender_country_iso": "004",
  "sender_address": "Street name 1",
  "ultimate_sender_name": "Jones Ltd.",
  "ultimate_sender_country_iso": "004",
  "ultimate_sender_organization_code": "004",
  "ultimate_sender_birth_date": "1986-06-08",
  "ultimate_sender_birth_city": "London",
  "ultimate_sender_birth_country_iso": "004",
  "ultimate_sender_private_identifier": "ID-2345",
  "ultimate_sender_private_issuer": "IS-12345",
  "ultimate_sender_private_code": "0004",
  "ultimate_sender_private_proprietary": "Property",
  "ultimate_sender_organization": "true",
  "ultimate_receiver_name": "Anthony Ltd.",
  "ultimate_receiver_country_iso": "004",
  "ultimate_receiver_organization_code": "005",
  "ultimate_receiver_birth_date": "1977-08-08",
  "ultimate_receiver_birth_city": "London",
  "ultimate_receiver_birth_country_iso": "004",
  "ultimate_receiver_private_identifier": "ID-3555",
  "ultimate_receiver_private_issuer": "IS-333",
  "ultimate_receiver_private_code": "1111",
  "ultimate_receiver_private_proprietary": "Property",
  "ultimate_receiver_organization": "true",
  "amount": "5.00",
  "currency": "GBP",
  "transaction_status": 8,
  "notes": "Load from IBAN (GB77777777777777777) to Account (1753154). Reference - new reference.",
  "supplementary_data": "[{\"Name\":\"Amount\",\"Value\":\"100000.0\"},{\"Name\":\"BeneficiaryCreditInstitution\",\"Value\":\"040473\"}]",
  "iso20022_xml_document": "<Document xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns=\"urn:iso:std:iso:20022:tech:xsd:pacs.008.001.08\"><FIToFICstmrCdtTrf><GrpHdr><CreDtTm>1900-02-03T04:00:30+00:00</CreDtTm><NbOfTxs>1</NbOfTxs></GrpHdr><CdtTrfTxInf><PmtId><InstrId>Id12</InstrId><EndToEndId>EndId21</EndToEndId><UETR>d9bd8c6e-e1d9-405b-ac53-2fa197149d09</UETR></PmtId><IntrBkSttlmAmt Ccy=\"Eur\">1.01</IntrBkSttlmAmt><IntrBkSttlmDt>1900-11-01</IntrBkSttlmDt><ChrgBr>DEBT</ChrgBr><Dbtr><Nm>ExampleName</Nm></Dbtr><DbtrAcct><Id><IBAN>GB00AABB00001111000111</IBAN></Id></DbtrAcct><DbtrAgt><FinInstnId><BICFI>LLAABB11XXX</BICFI></FinInstnId></DbtrAgt><CdtrAgt><FinInstnId><BICFI>LLAABB11XXX</BICFI></FinInstnId></CdtrAgt><CdtrAcct><Id><IBAN>GB00AABB00001111000112</IBAN></Id></CdtrAcct><RmtInf><Ustrd>ExampleReference1</Ustrd></RmtInf></CdtTrfTxInf></FIToFICstmrCdtTrf></Document>",
  "additional_note":"Sender's note.",
  "purpose_code": "PTXP",
  "purpose_description": "Property Tax",
  "reference": "ABC123456",
  "created_at": "2019-12-16T13:42:39+00:00",
  "transaction_type": 8,
  "transaction_scheme": 1,
  "transaction_identifier": "TX123456789",
  "end_to_end_identifier": "end2End134789",
  "key": "_MERCHANT_KEY_",
  "ts": "_TIMESTAMP_",
  "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Payment request link

Create

Request

Parameter	M	Type	Length	Description
status	Y	AN	10	success/ fail.
link_id	Y	N	20
link_status	Y	N	1
tx_id	Y	N	20
receiving_account	Y	N	20
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
payer_first_name	Y	A	60
payer_last_name	Y	A	60
payer_email	Y	AN	100
method	Y	AN	45	E.g. paypal.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "status": "success",
   "link_id": "123456789",
   "link_status": "3",
   "tx_id": "123456",
   "receiving_account": "123456",  
   "amount": "2.00",
   "currency": "USD",
   "payer_first_name": "John",
   "payer_last_name": "Doe",
   "payer_email": "john.doe@test.loc",
   "method": "paypal",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Wire

Load

Receive money payment request.

Request

Parameter	M	Type	Length	Description
status	Y	AN	10	success/ fail.
type	Y	AN	4
status_id	Y	N	1
account_id	Y	N	20	Account ID.
reference_number	Y	AN	100
custom_order_id	Y	AN	50
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
settled_amount	Y	N	10,2
settled_currency	Y	A	3	ISO 4217
transaction_id	Y	N	20	Unique transaction ID.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "status": "success",  
   "type": "mu2m",  
   "status_id": "3",  
   "account_id": "1753154",  
   "reference_number": "P000123-000321-001",  
   "custom_order_id": "ABC123",  
   "amount": "100.00",  
   "currency": "EUR",  
   "settled_amount": "100.00",  
   "settled_currency": "EUR",  
   "transaction_id": "1166071",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Whenever bank transfer is completed or canceled IPN is sent to the merchant provided URL. Merchant can setup different URL for successfully completed or failed transfer if needed. Of course same URL can be used for both cases. URL setup page can be found under profile tab API. Note that POST will be sent to the provided URL. Example of data sent: Wire transfer.

Withdraw

Send money payment request.

Request

Parameter	M	Type	Length	Description
status	Y	AN	10	success/ fail.
type	Y	AN	4
status_id	Y	N	1
account_id	Y	N	20	Account ID.
reference_number	Y	AN	100
custom_order_id	Y	AN	50
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
settled_amount	Y	N	10,2
settled_currency	Y	A	3	ISO 4217
transaction_id	Y	N	20	Unique transaction ID.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "status": "success",  
   "type": "mm2u",  
   "status_id": "3",  
   "account_id": "1753154",  
   "reference_number": "P000123-000321-001",  
   "custom_order_id": "ABC123",  
   "amount": "100.00",  
   "currency": "EUR",  
   "settled_amount": "100.00",  
   "settled_currency": "EUR",  
   "transaction_id": "1166071",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Whenever bank transfer is completed or canceled IPN is sent to the merchant provided URL. Merchant can setup different URL for successfully completed or failed transfer if needed. Of course same URL can be used for both cases. URL setup page can be found under profile tab API. Note that POST will be sent to the provided URL. Example of data sent: Wire transfer.

Wire (added bank account)

Load

Request

Parameter	M	Type	Length	Description
status	Y	AN	10	success/fail.
type	Y	AN	4
account_id	Y	N	20	Account ID.
reference_number	Y	AN	100
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
settled_amount	Y	N	10,2
settled_currency	Y	A	3	ISO 4217
transaction_id	Y	N	20	Unique transaction ID.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "status": "success",
   "type": "b2a",  
   "account_id": "1753154",  
   "amount": "105.11",  
   "currency": "EUR",  
   "reference_number": "XXX107817236",  
   "settled_amount": "106.00",  
   "settled_currency": "EUR",    
   "transaction_id": "1166071",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Withdraw finish

Request

Parameter	M	Type	Length	Description
status	Y	AN	10	success/fail.
type	Y	AN	4
account_id	Y	N	20	Account ID.
reference_number	Y	AN	100
amount	Y	N	10,2
currency	Y	A	3	ISO 4217
settled_amount	Y	N	10,2
settled_currency	Y	A	3	ISO 4217
transaction_id	Y	N	20	Unique transaction ID.
key	Y	AN	16	Merchant API Key – provided by Paytriot.
ts	Y	N	10	Request timestamp.
sign	Y	AN	32	See Sign generation.

{
   "status": "success",
   "type": "a2b",  
   "account_id": "1753154",  
   "amount": "19.50",  
   "currency": "EUR",  
   "reference_number": "XXX203104934",  
   "settled_amount": "19.50",  
   "settled_currency": "EUR",
   "transaction_id": "1166071",  
   "key": "_MERCHANT_KEY_",  
   "ts": "_TIMESTAMP_",  
   "sign": "_SIGN_"
}

Response

Parameter	M	Type	Length	Description
status	Y	A	255

{
    "status": "OK"
}

Appendix

Changelog

Version	Date	Updates
1.1.76	November 21, 2023	Field bday has been updated to mandatory Y Create user.
1.1.75	November 15, 2023	The maximum length of the parameter 'reference' is updated to 255 on these webhooks: - Transfer IBAN to Account Settlement - Transfer IBAN to Account Settlement with return - Transfer IBAN to Account Held - Transfer IBAN to Account Held Rejected - Transfer IBAN transaction reversed
1.1.74	October 18, 2023	New codes from 701 to 723 have been added to Message code list.
1.1.73	October 12, 2023	New accounts_ids, user_id and username fields have been added to Card issuing completed webhook.
1.1.72	October 04, 2023	- New API method - Change card status. - New enum - Card status
1.1.71	September 26, 2023	New message code 429 - Too many requests. Try again after {{time}} added. New webhook has been added: - Card transaction. - New enums have been added: - Card transaction types - Entry mode types - Card transaction status
1.1.70	August 16, 2023	- New confirmation_of_payee_id field has been added to Account to IBAN and Verify bank account address actions. - New action added Opt out/in bank account address
1.1.69	August 08, 2023	New scheme 'SWIFT' added to Schemes
1.1.68	June 28, 2023	New API actions have been added: - Get card ACS password - Change card ACS password New webhooks have been added: - Card issue completed. - Card issue failed. Changes have been made in codes list IBAN Outbound return message codes: Provider have been unasssigned from error codes '653', '662', '664' and new eror codes have been added '654', '655', '665', '667', '668'. Field 'iso20022_xml_document' added to webhooks: - Iban inbound settled - Iban inbound held - Iban inbound held rejected - Iban transaction reversed - Iban inbound settled with return - Iban outbound returned - Iban outbound return rejected.
1.1.67	June 14, 2023	Fields tax_country_code and citizenship_country_codes added to action Create User
1.1.66	June 1, 2023	Field 'type' has been added to action: IPN call resend. Additionally, field 'error_message' has been added to IBAN create failed webhook and Get IBAN by request ID action.
1.1.65	April 05, 2023	Field scheme added to action: Iban withdraw. Additionally, transfer scheme codes added to IBAN transfer scheme
1.1.64	April 04, 2023	Fields 'ultimate_sender_name', 'ultimate_sender_country_code', 'ultimate_sender_organization_code', 'ultimate_sender_birth_date', 'ultimate_sender_birth_city', 'ultimate_sender_birth_country_code', 'ultimate_sender_private_identifier', 'ultimate_sender_private_issuer', 'ultimate_sender_private_code', 'ultimate_sender_private_proprietary', 'ultimate_sender_organization', 'ultimate_receiver_name', 'ultimate_receiver_country_code', 'ultimate_receiver_organization_code', 'ultimate_receiver_birth_date', 'ultimate_receiver_birth_city', 'ultimate_receiver_birth_country_code', 'ultimate_receiver_private_identifier', 'ultimate_receiver_private_issuer', 'ultimate_receiver_private_code', 'ultimate_receiver_private_proprietary', 'ultimate_receiver_organization' added to action: Iban withdraw. Additionally, field 'receiver_city' max length increased to 50. Fields 'ultimate_sender_name', 'ultimate_sender_country_iso', 'ultimate_sender_organization_code', 'ultimate_sender_birth_date', 'ultimate_sender_birth_city', 'ultimate_sender_birth_country_iso', 'ultimate_sender_private_identifier', 'ultimate_sender_private_issuer', 'ultimate_sender_private_code', 'ultimate_sender_private_proprietary', 'ultimate_sender_organization', 'ultimate_receiver_name', 'ultimate_receiver_country_iso', 'ultimate_receiver_organization_code', 'ultimate_receiver_birth_date', 'ultimate_receiver_birth_city', 'ultimate_receiver_birth_country_iso', 'ultimate_receiver_private_identifier', 'ultimate_receiver_private_issuer', 'ultimate_receiver_private_code', 'ultimate_receiver_private_proprietary', 'ultimate_receiver_organization' added to webhooks: - Iban outbound rejected - Iban outbound held - Iban outbound returned - Iban outbound settled with return - Iban outbound settled - Iban inbound settled with return - Iban inbound settled - Iban inbound held - Iban inbound return completed - Iban inbound return rejected - Iban inbound return failed
1.1.63	January 24, 2023	Action changes in - Add bank account - Field bank_iban is no longer mandatory - changed to conditional. - Added new fields bank_account_number, bank_sort_code, bank_routing_number, bank_financial_system_code. Action changes in - Wire withdrawal and Wire withdrawal (business) - Added new fields receiver_bank_sort_code, receiver_bank_routing_number, receiver_bank_branch_code, receiver_bank_financial_system_code.
1.1.62	January 09, 2023	New webhook has been added IBAN transaction reversed.
1.1.61	January 03, 2023	Descriptions of request fields 'bank_account_holder_first_name' and 'bank_account_holder_last_name' have been changed. See Create IBAN action. Description of request field 'business_name' has been changed. See Create business IBAN action.
1.1.60	November 25, 2022	'iban' field type has been change from 'N' to 'AN' in action - Verify Bank Account Address API endpoint Create Card updates: Deprecated parameters: - 'username' - 'nationality' - 'first_name' - 'middle_name' - 'last_name' - 'family_status' - 'gender' - 'title' - 'dob' - 'email' - 'phone' - 'language' Updated parameters: - 'accounts'. Description changed from 'Accounts must be comma , separated, associated with user and different currency.' to 'Account ID'. - 'embossed_name'. Length changed from (3-21) to 100 and description has been updated. - 'city'. Length changed from 100 to 50. - 'state'. Became non-mandatory and length changed from 100 to 50. - 'post_code'. Length changed from 10 to 9.
1.1.59	November 22, 2022	'reason_code' mandatory field has been changed to optional in webhooks - Transfer Account to IBAN Return and Transfer Account to IBAN Return Rejected.
1.1.58	November 11, 2022	Fields 'accounts_ids' and 'currencies' added to the following actions: - Iban create - Iban create business New field 'iban_accounts' added to the following webhooks: - Iban create completed - Iban create failed
1.1.57	November 03, 2022	Fields 'receiver_bank_name', 'receiver_bank_bic', 'receiver_bank_routing_number', 'receiver_bank_clearing_system_iso_code', 'receiver_bank_clearing_system_member_id', 'receiver_bank_country_iso' added to webhooks: - Iban outbound rejected - Iban outbound held - Iban outbound settled - Iban inbound settled with return - Iban inbound return completed - Iban inbound return failed New fields 'receiver_bank_name', 'receiver_bank_bic', 'receiver_bank_routing_number', 'receiver_bank_clearing_system_iso_code', 'receiver_bank_clearing_system_member_id', 'receiver_bank_country_code' added. Additionally, the maximum 'receiver_name' length has been changed from 50 to 70 for the following actions: - Iban withdraw - Iban inbound return New field 'currency_code' added for action Iban status change and webhook Iban status change.
1.1.56	September 20, 2022	Removed Starling Bank from API documentation.
1.1.55	September 14, 2022	New API methods - Transaction status by ID or Request reference and IPN call resend.
1.1.54	September 06, 2022	New 'merchant_website' and 'merchant_city' fields have been added. See Create a new payment request link.
1.1.53	August 03, 2022	Added new IBAN request status '10' (Pending Risk checks for auto confirm) and updated '7' description to "Pending OFAC/AML/Risk checks" in IBAN request statuses.
1.1.52	July 11, 2022	New API method - Verify bank account address. New enum - Legal owner type.
1.1.51	June 29, 2022	Create User parameter 'password' lenght reduced to 50.
1.1.50	June 01, 2022	New codes '545' and '546' have been added to Message code list.
1.1.49	May 20, 2022	Added new 7 - 'Pending OFAC and PEP checks', 8 - 'Failed and need more investigation', 9 - 'Preparing to be exported' values in IBAN request statuses Enum.
1.1.48	April 12, 2022	'sender_account_name' and 'receiver_account_name' field lengths have been increased from '40' to '255' in all webhooks related to sections: - Transfer/Account to Direct Debit - Transfer/Account to IBAN - Transfer/Direct credit to Account - Transfer/IBAN to Account 'sender_iban' mandatory field has ben changed to optional in webhooks: - Transfer Account to IBAN Cancel Completed - Transfer Account to IBAN Returned - Transfer Account to IBAN Return Rejected 'receiver_iban' mandatory field has ben changed to optional in webhooks: - Transfer Account to IBAN Rejected - Transfer IBAN to Account Return Completed - Transfer IBAN to Account Return Failed New fields have been added to webhooks: - Transfer IBAN to Account Return Completed ('sender_account_number', 'sender_sort_code', 'receiver_country_iso') - Transfer IBAN to Account Return Failed ('sender_account_number', 'sender_sort_code', 'receiver_account_number', 'receiver_sort_code', 'receiver_country_iso', 'transaction_identifier', 'end_to_end_identifier', 'reference')
1.1.47	March 23, 2022	Outbound IBAN transfers webhooks updates: -Added bank_provider_reason_code field to Outbound reject webhook. -Added new fields bank_provider_reason_code, reference, transaction_identifier, end_to_end_identifier to Outbound return rejected webhook. -Added new fields reference, transaction_identifier, end_to_end_identifier to Outbound return webhook.
1.1.46	March 14, 2022	New receiver fields added to Inbound return action. Field supplementary_data added to these webhooks: - Iban inbound settled - Iban inbound held - Iban outbound rejected - Iban outbound held - Iban outbound settled. New fields (receiver_sort_code and receiver_account_number) added and field receiver_iban now is optional in IBAN Load return completed webhook.
1.1.45	February 15, 2022	New request_reference field has been added in Get IBAN request by ID and existing iban_request_id field is set to be conditional following the updated description.
1.1.43	February 08, 2022	New statuses (4 - Approve in progress, 5 - Reject in progress) have been added in Cancel request status. Added new field 'language_code' in Create User action's request and Create Merchant action's request. New Message code of value 538 - "Invalid currency provided." has been added.
1.1.42	January 21, 2022	New optional field transfer_charge_code added to: Wire Withdraw Wire Withdraw (business) Wire Withdraw to bank
1.1.41	January 07, 2022	Updated 'receiver_bank_iban' (At Wire Withdraw, Wire Withdraw (business)) and 'payer_bank_iban' (At Wire Load, Wire Load (business)) parameters length from 40 to 34 and added additional note for that. Also updated all wire transfer action request parameters and example data to properly reflect data that is expected to be received by each action Wire Load, Wire Load (business), Wire Withdraw.
1.1.40	December 30, 2021	New 'primary' field has been added to Add bank account action. New API action Wire withdraw (business) has been added.
1.1.39	November 29, 2021	Bussiness persons input type has been updated in Create Merchant.
1.1.38	November 04, 2021	Updated 'internal_name' field description to mark allowed characters and symbols for actions: IBAN create action, IBAN business create action. Added a new table to notations section to define allowed special characters, signs and symbols Special symbols. Added new appendix for Payment transaction types.
1.1.37	October 15, 2021	New 'payer_company_category_id' field has been added. See Wire load (business).
1.1.36	September 02, 2021	'bank_account_holder_city' field description has been updated for following actions: Create IBAN, Create business IBAN, Update IBAN, Update business IBAN. Length of 'bank_account_holder_city' depends on the provider.
1.1.35	August 02, 2021	destination_tag parameter for Ripple XRP crypto currency withdraw request is now mandatory.
1.1.34	July 28, 2021	'end_to_end_identifier', 'transaction_identifier' fields have been added to 6 webhooks: IBAN to Account Settlement, IBAN to Account Settlement with Return, IBAN to Account Held, IBAN to Account Held Rejected, Direct Credit to Account Received, Direct Credit to Account Settled. 'end_to_end_identifier', 'transaction_identifier', 'reference' fields have been added to 5 webhooks: IBAN to Account Return Completed, Account to Direct Debit Due, Account to Direct Debit Paid, Account To Direct Debit Rejected, Account to Direct Debit Paid with Return.
1.1.33	June 14, 2021	Description of value 512 has been updated in Message code. Regarding 2FA validation fields, new guidelines have been added for actions: External transfer initialize. External transfer finish. External load from card initialize. External load from card finish. External card load from unverified card initialize. External card load from unverified card finish. Withdraw to bank initialize. Withdraw to bank finish. Crypto transfer initialize. Crypto transfer finish.
1.1.32	May 19, 2021	Description of request field 'credit_card_id' has been changed. See Initialize load from external card.
1.1.31	April 27, 2021	New IBAN statuses of value 8 - "Suspended by Risk" and 9 - "Suspended by AML" have been added.
1.1.30	April 21, 2021	Create Merchant parameter 'company_name' is updated to be type of AN and length of 200.
1.1.29	March 24, 2021	New Message code of value 539 - "Your IBAN is unavailable" has been added.
1.1.28	March 03, 2021	The lenght of address fields has been lowered from 100 to 70 in these IBAN actions: Create, Create Business, Update, Update Business. 'receiver_account_number' length has been changed from 34 to 26 in Account to IBAN transfer call and in all other related IBAN webhooks with such field names as 'account_number', 'originator_account_number', 'receiver_account_number', 'sender_account_number'.
1.1.27	February 02, 2021	New 'industry_id' field has been added. See Update business iban details, IBAN create completed webhook, IBAN details changed webhook.
1.1.26	December 03, 2020	New webhook Risk suspend account.
1.1.25	November 17, 2020	New 'client_tag' field has been added. See Account to IBAN transfer.
1.1.24	September 22, 2020	Direct debit return's integration updates: - Added new Direct debit return call. - Added new IBAN direct debit return message codes enum section. - Added new Account to Direct debit related webhooks: Returned, Return rejected, Paid with return. - Added new Account to IBAN return related webhooks: Return rejected, Settlement with return. - Added 'returned_transaction_type' and 'return_request_reference' fields in Account to IBAN Return rejected webhook. - Updated IBAN outbound return messages by adding ClearBank related codes.
1.1.23	Septemper 08, 2020	Direct debit integration updates: - Added new mandates related webhooks: Activated, Migrated, Activation failed, Rejection failed, Cancelation failed. - Added new Direct debit mandate enum section with statuses, types, cancelation and rejection reasons. - Updated Mandate cancel call with new 'reason_code' field and added new Mandate reject call. - Updated Mandate created and Mandate canceled webhooks by adding additional fields about originator and mandate details. - Updated Account To Direct Debit Due, Paid, Rejected webhooks by adding new fields about receiver, transaction scheme and creation time. New 'paid_at' field has been added on Paid webhook. - New 'destination_mandate' list field has been added in Account activity action's response.
1.1.22	August 18, 2020	New 'sender_country_iso' field has been added. See Direct credit settled.
1.1.21	July 27, 2020	New IBAN to Account settlement with return webhook has been added. IBAN Inbound return messages for ClearBank has been updated. 'Settle' title has been renamed to 'Settlement' in webhooks: Account to IBAN settlement, IBAN to Account settlement.
1.1.20	July 21, 2020	Added a new withdraw to crypto functionality. See transfer account to crypto 'post_code' and 'billing_post_code' fields have been changed to 'postal_code' and 'billing_postal_code' in Change Account address action's response. 'corresponding_bank_swift', 'corresponding_bank_name', 'corresponding_bank_city', 'corresponding_bank_currency_code' fields have been added in Add bank account action's request. 'address1', 'address2', 'post code', 'billing_address1', 'billing_address2', 'billing_post_code' fields have been changed to 'address_line1', 'address_line2', 'postal_code', 'billing_address_line1', 'billing_address_line2', 'billing_postal_code' in Change User address action's response. 'address1', 'address2' 'billing_address1', 'billing_address2' fields changed to 'address_line_1', 'address_line_2', 'billing_address_line_1' 'billing_address_line_2' in Create User action's request. 'comment' field added to Create Merchant action's request. 'date_from', 'date_to', 'from_id' fields position was changed in Get Merchant Users action's request.
1.1.19	July 15, 2020	New Direct credit to Account received webhook has been added. 'sender_iban', 'sender_account_name', 'sender_account_number', 'sender_sort_code', 'transaction_status', 'created_at' fields have been added to Direct credit to Account settled webhook.
1.1.18	July 09, 2020	'request_reference' field has been added to IBAN create action, IBAN business create action, IBAN create completed webhook, IBAN create failed webhook.
1.1.17	June 02, 2020	New IBAN transfer type enum has been added. 'transaction_type' and 'transaction_scheme' fields have been added to 13 webhooks: Account to IBAN cancel completed, Account to IBAN rejected, Account to IBAN returned, Account to IBAN settled, Account to IBAN held, Direct credit to Account settled, IBAN to Account return completed, IBAN to Account return failed, IBAN to Account return declined, IBAN to Account reversed, IBAN to Account settled, IBAN to Account held, IBAN to Account held rejected. New 'vat_number' field added. See Create Merchant.
1.1.16	May 26, 2020	Added Payment request link status.
1.1.15	May 20, 2020	Parameter 'expiration_date' input value changed. See transfer_c_to_a.
1.1.14	May 18, 2020	New Get industries action has been added. 'industry_id' field has been added to Account to IBAN action. 'account_holder_risk_score' field has been added to IBAN create action. 'bank_account_holder_postal_code', 'bank_account_holder_city', 'bank_account_holder_state', 'bank_account_holder_country_iso_code', 'date_of_company_incorporation', 'industry_id', 'account_holder_risk_score' fields have been added to Business IBAN create action. 'bank_account_holder_postal_code', 'bank_account_holder_city', 'bank_account_holder_state', 'bank_account_holder_country_iso_code' fields have been added to Business IBAN update action.
1.1.13	May 12, 2020	'reference' field has been added to 3 webhooks: IBAN to Account Settled, IBAN to Account Held, IBAN to Account Held Rejected. New 'response' fields has been added to Get user account action ("is_primary" and "account_type"). Parameters "directors", "shareholders", "beneficial_owners" of action create_merchant have become not mandatory.
1.1.12	May 11, 2020	New IBAN transfer scheme enum has been added. 'parent_tx_id', 'transaction_type' and 'additional_info' fields have been added in Account activity action's response. 'parent_tx_id', 'transaction_type' fields have been added in Card activity action's response.
1.1.11	May 05, 2020	'receiver_type' field has been added to Account to IBAN action. New '689 - Method not supported.' message code has been added in Message codes. New 'OTH - Other.' withdrawal purpose code added in Withdrawal purposes. 'created_at' field has been added to 6 webhooks: Account to IBAN Settled, Account to IBAN Returned, Account to IBAN Held, Account to IBAN Rejected, IBAN to Account Reversed, IBAN to Account Return Failed.
1.1.10	April 28, 2020	'request_reference' field has been added to Account to IBAN Held webhook. 'canceled_transaction_request_reference' field has been renamed to 'request_reference' in webhooks: Account to IBAN cancel completed, Account to IBAN cancel rejected. 'returned_transaction_request_reference' field has been renamed to 'request_reference' in Account to IBAN return webhook.
1.1.9	April 27, 2020	'reason_code' and 'reason_description' fields have been added to Account to IBAN rejected webhook. 'reason_description' field has been added to IBAN to Account reversed webhook.
1.1.8	April 22, 2020	New IBAN actions have been added: Update, Update business New webhook has been added IBAN details changed.
1.1.7	April 21, 2020	Parameter "is_private_company" of action create_merchant has become not mandatory.
1.1.6	April 16, 2020	Added a new webhook. See IBAN Inbound return declined.
1.1.5	April 14, 2020	Added new parameter "error_message" to purchase finish webhook.
1.1.4	April 09, 2020	Return/Cancel instruction reasons depends on used provider. See IBAN bank providers.
1.1.3	April 08, 2020	New 'reference' field has been added to Account to IBAN action. 3 New transfer webhooks have been added: Account to IBAN Held, IBAN to Account Held, IBAN to Account Held Rejected.
1.1.2	April 07, 2020	Parameter "receiver_gender" of action "bank_transfer" has become not mandatory. transfer_a_to_iban action's field "message_for_receiver" limit has been modified from 35 to 140.
1.1.1	March 24, 2020	A new type of parameter "C", which stands for "Conditional", has been added to actions create_iban and create_business_iban.
1.1.0	March 24, 2020	Initial version.

Enum

Account status

Status ID	Description
1	Normal
2	Blocked
3	Receive only
4	Spend only
5	Pending
6	Banned
7	Closed
8	Suspended
9	Closed by customer request
10	Closed by A: Fraudulent
11	Closed by A: Banned activity
12	Closed by A: No KYC
13	Closed by A: Other
14	Closed by CR: No KYC
15	Closed by CR: Other
16	Closed by CR: 2 profiles
17	Suspended by admin
18	Closed by A: Fake KYC
19	Closed by customer

Crypto currency

Name	Key	Length
Bitcoin	BTC	10,8
Ethereum	ETH	10,9
Litecoin	LTC	10,8
Ripple	XRP	10,6
Bitcoin Cash	BCH	10,8
Tether	USDT	10,6
Chainlink	LINK	10,6
USD Coin	USDC	10,6

Invalid request error code

Type ID	Description
1001	API version parameter v is not provided.
1002	Wrong API version provided.
1003	Function name parameter function is not provided.
1004	Wrong method name provided.
1005	No data received.
1006	Required field is not provided or is empty.
1007	System error.

KYC document Type

Type ID	Description	Mandatory to provide company name
4	Passport	N
5	Drivers License Front	N
6	State/Province ID Front	N
7	Utility Bill	Y
8	Bank Statement	N
9	Credit/Debit Card Front	N
10	ACH Voided Check	N
11	Check21	N
12	Marriage Certificate	N
13	Power of Attorney	N
14	Subpoena	N
15	Marriage Dissolution	N
16	Notarized Statement	N
17	Document of Legal Name Change	N
18	Police Report	N
19	Disputes	N
20	Wire Transfers	N
21	Limit Increase	N
22	Email Change	N
23	ACH Demand Draft	N
24	Application Form	N
26	Contract	N
28	Incorporation of Company	N
30	Memorandum and Articles	Y
32	Shareholder Documentation	N
34	Proof of Company Address	N
36	Other	N
38	Company registration documents	N
40	Paytriot Statement	N
42	Credit/Debit Card Back	N
44	Business Proposal	N
46	Business Agreement	N
48	Agent Agreement	N
50	Driver’s License Back (if applicable)	N
52	Passport-Additional Pages (if applicable)	N
54	State/Province ID Back (if applicable)	N
56	Government-issued ID	N
58	Personal Identification Card	N
60	Residence Permit	N
62	Screenshot	N

KYC status

Status ID	Description
2	Approved
3	Rejected
4	Pending
6	Requested
8	Under review
9	Expired

Message code

Code	Description
000	Successfully completed.
100	Load limit exceeded (value of transactions).
101	Load limit exceeded (number of transactions).
102	Transfer limit exceeded (maximum transaction amount allowed).
103	Transfer limit exceeded (value of transactions).
104	Transfer limit exceeded (number of transactions).
105	Withdrawal limit exceeded (value of transactions).
106	Withdrawal limit exceeded (number of transactions).
107	Withdrawal limit exceeded (maximum transaction amount allowed).
108	Card throughput limit exceeded (must provide KYC documents).
110	Transfer restricted.
111	Load restricted.
112	Recipient cannot accept transfers.
113	Account balance exceeded.
114	Operation is not allowed.
115	Wrong receiving account provided.
116	Wrong sending account provided.
117	Sending and receiving accounts cannot be the same.
200	Insufficient funds.
300	Card is inactive.
400	Could not find currency rate.
429	Too many requests. Try again after {{time}}.
500	Invalid signature.
501	Error creating session.
502	Operation is not allowed.
503	Missing field.
504	Field format error.
505	Invalid receiver account.
506	User not found.
507	Invalid currency code.
508	Invalid sender account.
509	Define sender account.
510	Duplicate order_id.
511	Initialized transaction not found.
512	Two factor authorization (2FA) error.
513	Transfer request already confirmed.
514	Transaction not found.
515	Transaction cannot be refunded.
516	Cannot refund this amount.
517	Your transaction request was sent to our Bank for processing.
520	Invalid username provided.
521	Invalid account provided.
522	Invalid data provided.
523	Invalid external card id provided.
524	Wrong verification amount.
525	Verification attempts limit reached.
526	Verification failed.
527	Invalid card status.
528	S3D cards not supported.
529	Configuration error.
536	Bank error.
538	Invalid currency provided.
539	Your IBAN is unavailable.
540	This action is temporarily disabled. Please contact Customer Support for further assistance.
543	This method with no expiration is not available..
544	You are not allowed to make links with no expiration. Please contact Customer Support for further assistance.
545	Receiver IBAN is invalid.
546	Lock on request failed.
600	Limitation reached.
650	Account closed.
651	Account blocked.
652	Account holder deceased.
653	Not specified reason by customer.
654	Not specified reason by agent.
655	Transaction is forbidden.
656	Invalid bank operation code.
657	Duplication.
658	Missing creditor address.
659	Following cancelation request.
660	Missing debtor account or identification.
661	Missing debtor name or address.
662	Missing creditor name or address.
663	Regulatory reason.
664	Account transferred.
665	Reference required not supplied.
666	Account name mismatch.
667	Terms and conditions of account do not permit crediting of these funds.
668	Sending institution action required.
669	Payment return reason is not specified.
670	Other reasons.
671	Do not honor (refused).
672	Wrong IBAN.
673	Wrong amount.
674	Fraudulent original credit transfer.
675	Technical problems.
676	Following cancelation request.
677	Requested by customer.
678	Already returned transaction.
679	Legal decision.
680	No answer from customer.
681	No original transaction received.
682	Duplicate payment.
683	ERI option not supported.
684	Fraudulent payment suspected.
685	Incorrect transaction information.
686	Provider issue.
687	Time out.
688	Account can not be identified.
689	Method not supported.
701	Card transaction was declined by provider.
702	Invalid amount.
703	Invalid card number.
704	Lost card.
705	Stolen card.
706	Insufficient funds.
707	Expired card.
708	Invalid pin.
709	Suspected fraud.
710	Exceeds withdrawal limit.
711	Pin tries exceeded.
712	Invalid merchant.
713	Do not honor.
714	Format error.
715	Invalid account.
716	Invalid from account.
717	Invalid transaction.
718	Exceeds approval limit.
719	Additional authentication required.
720	Card not initialized.
721	Restricted card.
722	Duplicated transaction.
723	Requested function not supported.
810	Destination tag is required.
999	Unknown error.
-	User approved.
-	User already approved.

Purchase status

Type ID	Description
1	Created
2	Logged in
4	Processing
7	Canceled
8	Failed
9	Successful

User ID Type

Type ID	Description
1	Passport Registry No.
2	Personal Identification No.
3	Identity Card No.
4	Utility Bill.
8	Travel Document.
12	Residence Permit.
13	Identity Certificate No.
16	Registro Federal de Contribuyentes.
17	Credencial de Elector.
19	Social Security Number (US only).
20	Tax File Number (Australia only).

Withdrawal purpose

Purpose ID	Code	Description
1	MWI	Mobile wallet cash in.
2	MWO	Mobile wallet cash out.
3	MWP	Mobile wallet payments.
4	SVI	Stored value card cash-in.
5	SVO	Stored value card cash-out
6	SVP	Stored value card payments.
7	FSA	Equity other than investment fund shares in the related companies abroad.
8	ACM	Agency Commission.
9	AFA	Receipts or payments from personal residents bank account or deposits abroad.
10	ALW	Allowances.
11	ATS	Air transport.
12	CCP	Corporate Card Payment.
13	CEA	Equity for the establishment of new company from residents abroad equity of merger or acquisition of companies abroad from residents and participation to capital increase of related company abroad.
14	CEL	Equity for the establishment of new company in the UAE from residents equity of merger or acquisition of companies in the UAE from n-residents participation to capital increase of related companies.
15	CHC	Charitable Contributions.
16	COM	Commission.
17	COP	Compensation.
18	CRP	Credit Card Payments.
19	DCP	Pre-Paid Reloadable and Personalized Debit Card Payments.
20	DIV	Dividend Payouts.
21	DOE	Dividends on equity not intra group.
22	EDU	Educational Support.
23	EMI	Equated Monthly Instalments.
24	EOS	End of Service.
25	FAM	Family Support.
26	FIS	Financial services.
27	FSL	Equity other than investment fund shares in related companies in the UAE.
28	GDS	Goods Bought or Sold.
29	GMS	Processing repair and maintenance services on goods.
30	GOS	Government goods and services embassies etc.
31	GRI	Government related income taxes tariffs capital transfers etc.
32	IFS	Information services.
33	IGD	Intra group dividends.
34	IGT	INTER GROUP TRANSFER.
35	INS	Insurance services.
36	IPC	Charges for the use of intellectual property royalties.
37	ITS	Computer services.
38	LAS	Leave Salary.
39	MCR	Monetary Claim Reimbursements Medical Insurance or Auto Insurance etc.
40	OAT	OWN ACCOUNT TRANSFER.
41	OTS	Other modes of transport.
42	OVT	Overtime.
43	PEN	Pension.
44	PMS	Professional and management consulting services.
45	POS	POS Merchant Settlement.
46	PRS	Personal cultural audio visual and recreational services.
47	RDS	Research and development services.
48	RNT	Rent Payments.
49	SAL	Salary.
50	SCO	Construction.
51	STR	Travel.
52	STS	Sea transport.
53	SAA	Salary Advance.
54	TCS	Telecommunication services.
55	TKT	Tickets.
56	TOF	Transfer of funds between persons Normal and Juridical.
57	UTL	Utility Bill Payments.
58	OTH	Other.

External card deposit categories

Code	Description
1	Top up account
2	Option 2
3	Option 3

Bank account address

Legal owner types

Type value	Description
PERSONAL	Personal account
BUSINESS	Business account

IBAN

Status

Status ID	Description
1	Send and receive funds
2	Receive funds only
3	Spend funds only
4	Suspended by Admin
5	Disabled
6	Suspended by User
7	Suspended by System
8	Suspended by Risk
9	Suspended by AML

Request status

Status ID	Description
1	Confirmed
2	Pending
3	Declined by admin
4	Failed
5	Done
6	Request sent and waiting for result
7	Pending OFAC/AML/Risk checks
8	Failed and need more investigation
9	Preparing to be exported
10	Pending Risk checks for auto confirm

Transaction status

Status ID	Description
1	Pending
2	Sent
3	Received
4	Accepted
5	Settled
6	Rejected
7	Returned
8	Reversed
9	Canceled
10	Held

Bank provider

Provider ID	Description
1	CENTROlink.
3	ClearBank.

IBAN transfer

IBAN Inbound return message codes

Code	Description	Bank provider
521	Incorrect account number.	CENTROlink, ClearBank
650	Account closed.	CENTROlink, ClearBank
651	Account blocked.	CENTROlink, ClearBank
652	Account holder deceased.	CENTROlink, ClearBank
653	Not specified reason by customer.	CENTROlink, ClearBank
654	Not specified reason by agent.	CENTROlink, ClearBank
655	Transaction is forbidden.	CENTROlink, ClearBank
656	Invalid bank operation code.	CENTROlink, ClearBank
657	Duplication.	CENTROlink, ClearBank
658	Missing creditor address.	CENTROlink, ClearBank
659	Following cancelation request.	CENTROlink, ClearBank
660	Missing debtor account or identification.	CENTROlink, ClearBank
661	Missing debtor name or address.	CENTROlink, ClearBank
662	Missing creditor name or address.	CENTROlink, ClearBank
663	Regulatory reason.	CENTROlink, ClearBank
664	Account transferred.	ClearBank
665	Reference required not supplied.	ClearBank
666	Account name mismatch.	ClearBank
667	Terms and conditions of account do not permit crediting of these funds.	ClearBank
668	Sending institution action required.	ClearBank
669	Payment return reason is not specified.	ClearBank
670	Other reasons.	ClearBank

IBAN Outbound return message codes

Code	Description	Bank provider
521	Incorrect account number.	CENTROlink, ClearBank
650	Account closed.	CENTROlink, ClearBank
651	Account blocked.	CENTROlink, ClearBank
652	Account holder deceased.	CENTROlink, ClearBank
653	Not specified reason by customer.
654	Not specified reason by agent.
655	Transaction is forbidden.
656	Invalid bank operation code.	CENTROlink
657	Duplication.	CENTROlink
658	Missing creditor address.	CENTROlink, ClearBank
659	Following cancelation request.	CENTROlink, ClearBank
660	Missing debtor account or identification.	CENTROlink, ClearBank
661	Missing debtor name or address.	CENTROlink, ClearBank
662	Missing creditor name or address.
663	Regulatory reason.	CENTROlink
664	Account transferred.
665	Reference required not supplied.
666	Account name mismatch.	ClearBank
667	Terms and conditions of account do not permit crediting of these funds.
668	Sending institution action required.
669	Payment return reason is not specified.
670	Other reasons.	ClearBank
675	Technical problems.	CENTROlink
683	ERI option not supported.
684	Fraudulent payment suspected.	CENTROlink
685	Incorrect transaction information.
686	Provider issue.
687	Time out.
688	Account can not be identified.

IBAN direct debit return message codes

Code	Description	Bank provider
521	Incorrect account number.	ClearBank
650	Account closed.	ClearBank
651	Account blocked.	ClearBank
652	Account holder deceased.	ClearBank
653	Not specified reason by customer.	ClearBank
658	Missing creditor address.	ClearBank
659	Following cancelation request.	ClearBank
660	Missing debtor account or identification.	ClearBank
661	Missing debtor name or address.	ClearBank
662	Missing creditor name or address.	ClearBank
664	Account transferred.	ClearBank
666	Account name mismatch.	ClearBank
670	Other reasons.	ClearBank

Cancel request status

Code	Description
1	Accepted
2	Pending
3	Rejected
4	Accept in progress
5	Reject in progress

Cancel request type

Code	Description
1	Inbound status report
2	Inbound cancel
3	Inbound resolution of investigation
4	Inbound request for status update

Inbound cancel request decline reason codes

Code	Description	Bank provider
200	Insufficient funds.	CENTROlink
650	Account is closed.	CENTROlink
677	Requested by customer.	CENTROlink
678	Already returned transaction.	CENTROlink
679	Legal decision.	CENTROlink
680	No answer from customer.	CENTROlink
681	No original transaction received.	CENTROlink

Outbound cancel

Request reason codes

Code	Description	Bank provider	Additional information required	Reason originator name required
672	Wrong IBAN.	CENTROlink	Yes	Yes
673	Wrong amount.	CENTROlink	Yes	Yes
674	Fraudulent original credit transfer.	CENTROlink	Yes	No
675	Technical problem.	CENTROlink	No	No
677	Requested by customer.	CENTROlink	Yes	Yes
682	Duplicate payment.	CENTROlink	No	No

Rejection reason codes

Code	Description	Bank provider
672	Wrong IBAN.	CENTROlink
673	Wrong amount.	CENTROlink
674	Fraudulent original credit transfer.	CENTROlink
675	Technical problem.	CENTROlink
677	Requested by customer.	CENTROlink
682	Duplicate payment.	CENTROlink

Scheme

ID	Code	Description
1	TRANSFER	Transfer.
2	FPS	Faster Payments.
3	CHAPS	CHAPS scheme.
4	BACS	Bacs scheme.
5	SCT	SEPA transfer.
6	SCTI	SEPA instant transfer.
7	SDD	SEPA direct debit.
9	SWIFT	SWIFT scheme.

Type

ID	Description
1	Single immediate payment
2	Forward date payment.
3	Standing order payment.
4	Inbound payment return.
5	Outbound payment return.
6	Direct debit payment.
7	Direct credit payment.
8	Payment reverse.
9	Payment cancel.
10	Debit fee.
11	Outbound payment cancel.

Direct debit mandate

Status

Status ID	Description
1	Active.
2	Canceled.
3	Activation error.
4	Pending.
5	Ready for cancellation.
6	Request sent for cancellation.
7	Ready for reject.
8	Request sent for rejection.

Type

Type ID	Description
1	Paper.
2	Origination.
3	Migrated.

Cancelation reason

Reason Code	Description
CANCELLED_BY_INSTITUTION	Institution cancelled - refer to payer. Paying bank has cancelled instruction.
CANCELLED_BY_PAYER	Instruction cancelled by payer. Payer has instructed the paying bank to cancel the DirectDebit Instruction (Mandate).
PAYER_DECEASED	Payer deceased.
ACCOUNT_CLOSED	Account closed. Payer has closed their account for an unknown reason.

Rejection reason

Reason Code	Description
CANCELLED_BY_PAYER	Payer has instructed paying bank to cancel DDI
PAYER_DECEASED	Payer deceased.
ACCOUNT_TRANSFERED_TO_DIFFERENT_INSTITUTION	Account transferred to another bank / building society.
ACCOUNT_NOT_FOUND	Account number is not recognised at the paying bank.
MANDATE_INSTRUCTION_NOT_FOUND	Instruction does not exist on paying bank’s database (only applies to receipt of a 0C).
PAYER_ACCOUNT_CLOSED	Payer has closed his account for an unknown reason.
ACCOUNT_MOVED_TO_DIFFERENT_BRANCH	New account details supplied to the service user by paying bank.
INVALID_PAYEE_ACCOUNT_TYPE	Paying bank does not allow Direct Debits on this type of account.
PAYEE_ACCOUNT_DIRECT_DEBIT_DISABLED	Paying bank does not allow Direct Debits on this account.
INSTRUCTION_HAS_EXPIRED	Occurs when a service user attempts to convert a DDI which is shown as expired on the paying bank’s database.
PAYER_REFERENCE_NOT_UNIQUE	Paying bank has matched the DDI to an existing DDI with a similar reference that has more or fewer characters.
PAYER_CANCELLED_DDI	Paying bank has cancelled the DDI.

Payment request link status

Status ID	Description
1	Active
2	Used
3	Paid
4	Expired
5	Canceled

Payment transaction type

Code	Description
a2a	Account to account transfer
a2ce	Account currency exchange to account
a2b	Account to bank account transfer
b2a	Bank account to account transfer
a2c	Account to card transfer
c2a	Card to account transfer
c2c	Card to card transfer
a2cup	Account to CUP (China Union Pay) transfer
mg2a	MoneyGram to account transfer
a2wu	Account to Western Union transfer
wu2a	Western Union to account transfer
a2astropay	Account to Astropay transfer
astropay2a	Astropay to account transfer
a2cc	Account to credit card transfer
cclink2a	Credit card link to account transfer
cc2a	Credit card to account transfer
a2paypal	Account to PayPal transfer
paypallink2a	PayPal link to account transfer
paypal2a	PayPal to account transfer
qiwilink2a	Qiwi link to account transfer
qiwi2a	Qiwi to account transfer
sofortlink2a	Sofort link to account transfer
sofort2a	Sofort to account transfer
ideallink2a	Sofort link to account transfer
ideal2a	Sofort to account transfer
a2payeer	Account to Payeer transfer
payeerlink2a	Payeer link to account transfer
payeer2a	Payeer to account transfer
polipaylink2a	Polipay link to account transfer
polipay2a	Polipay to account transfer
a2skrill	Account to Skrill transfer
skrilllink2a	Skrill link to account transfer
skrill2a	Skrill to account transfer
a2neteller	Account to Neteller transfer
netellerlink2a	Neteller link to account transfer
neteller2a	Neteller to account transfer
okpaylink2a	OkPay link to account transfer
okpay2a	OkPay to account transfer
a2remittance	Account to Remittance transfer
a2astropay	Account to Astropay transfer
astropay2a	Astropay to account transfer
alipay2a	Alipay to account transfer
wechat2a	Wechat to account transfer
a2btc	Account to Bitcoin transfer
btc2a	Bitcoin to account transfer
a2eth	Account to Ethereum transfer
eth2a	Ethereum to account transfer
a2ltc	Account to Litecoin transfer
ltc2a	Litecoin to account transfer
a2xrp	Account to Ripple transfer
xrp2a	Ripple to account transfer
a2bch	Account to Bitcoin Cash transfer
bch2a	Bitcoin Cash to account transfer
a2ra	Account to reserve account transfer
ar2a	Reserve account to account transfer
a2iban	Account to IBAN transfer
iban2a	IBAN to account transfer
a2directdebit	Account to direct debit transfer
directdebit2a	Direct debit to account transfer
directcredit2a	Direct credit to account transfer
r2b	Referral earnings

Card transaction types

Code	Name	Description
0	Unknown	Can’t determine transaction type.
1	Load	Card load via API.
2	POS	Purchase by card.
3	ATM	ATM withdrawal.
4	Unload	Card unload/withdrawal via API.
5	Credit cheque	Credit cheque.
6	Balance inquiry	Balance inquiry at ATM/POS.
7	Cashback	Cashback at sale point.
8	Cash	Cash withdrawal.
9	Quasi cash	Quasi cash operation.
10	Credit	Original credit operation.
11	Credit adjustment	Credit adjustment via API.
12	Refund	Refund transaction.
13	Debit adjustment	Debit adjustment via API.
14	PIN unblock	PIN unblock via ATM.
15	PIN change	PIN change at an ATM.
16	Reserved	Reserved for future use.
17	POS verification	POS verification only.
18	Money transfer	Money transfer operation (UnionPay).
19	P2P debit	P2P transfer debit part.
20	P2P credit	P2P transfer credit part.
21	Debit cheque	Original debit operation.
22	Card activate	Card activation.
23	PIN change via API	PIN change via API.
24	Dispute credit adjustment via API	Dispute credit adjustment via API.
25	Dispute debit adjustment via API	Dispute debit adjustment via API.

Entry mode types

Code	Name	Description
0	Irrelevant	This covers all entry mode types.
1	Magstripe	Card data was read from magnetic stripe.
2	Contactless	Card data was read via a contactless interface.
3	Ecomm	Card data was sent via e-commerce/internet website.
4	Reserved	Reserved for future use.
5	Optical code	Card data was read via an optical interface.
6	ICC	Card data was read via chip.
7	Credential on file	Card data was loaded from the merchant’s storage (recurring).
8	Moto	Card data was entered manually by an operator via a phone.
9	Manual	Card data was entered manually.
10	Card present	The physical payment card was present during the transaction.
11	Card not present	The physical payment card was not present during the transaction.
12	Unknown	Can’t determine entry mode type.

Card transaction status

Code	Name
1	Pending
2	Settled
3	Rejected

Card status

Code	Name	Description
A	Activated	Can be changed to S, L, F, P, B
S	Suspended	Can be changed to A, L, F, P, B
L	Lost	Can be changed to A, S, F, P, B
F	Fraud	Can be changed to A, S, L, P, B
P	Stolen	Can be changed to B
B	Blocked	Can't be changed

Example

Cryptography

Some information in response (like credit card number) will be encrypted so must use decryption function to get real information. For decrypt must have MERCHANT_3DES_KEY.

Decryption function in PHP:

function decrypt3DES($encrypted)
{
    $len = strlen(_MERCHANT_3DES_KEY_);
    $key = $len < 24 ? _MERCHANT_3DES_KEY_.substr(_MERCHANT_3DES_KEY_, 0, 24 - $len) : _MERCHANT_3DES_KEY_;

    return openssl_decrypt($encrypted, 'des-ede3-cbc', $key, false, substr(_MERCHANT_3DES_KEY_, 0, 8));
}

function encrypt3DES($data)
{
    $len = strlen(_MERCHANT_3DES_KEY_);
    $key = $len < 24 ? _MERCHANT_3DES_KEY_.substr(_MERCHANT_3DES_KEY_, 0, 24 - $len) : _MERCHANT_3DES_KEY_;

    return openssl_encrypt($data, 'des-ede3-cbc', $key, false, substr(_MERCHANT_3DES_KEY_, 0, 8));
}

Request function

function _request($servicename, $params)
{
    ini_set('max_execution_time', 300);
    $uri = '_SERVICE_URL_'.'/v/'.'_VERSION_'.'/function/'.'_API_FUNCTION_NAME_';
    $str = json_encode($params);
    $ch = curl_init($uri);
    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
    curl_setopt($ch, CURLOPT_POSTFIELDS, $str);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_TIMEOUT, 300);
    curl_setopt($ch, CURLOPT_HTTPHEADER, [
        'Content-Type: application/json',
        'Content-Length: '.strlen($str)]
    );
    $response = curl_exec($ch);
    curl_close($ch);

    return $response;
}

Sign generation

Sign of request, it is MD5 hash of keys, values and secret.

Example of Sign generation:

MD5("key1:value1: key2: value2:…:key:_MERCHANT_KEY_:ts:_TIMESTAMP_:_SECRET_")

Example in PHP:

function _sign($params)
{
    $strToSign = '';
    $params['key'] = '_MERCHANT_KEY_';
    $params['ts'] = time();
    foreach ($params as $k => $v) {
        if ($v !== NULL) {
            $strToSign .= "$k:$v:";
        }
    }
    $strToSign .= '_MERCHANT_SECRET_';
    $params['sign'] = md5($strToSign);

    return $params;
}

IPN catcher

KYC notification

if (!empty($_POST)) {
    $kyc_id = $_POST['id'];
    $msg = $_POST['msg']; // 'Status changed from [Requested] to [Rejected]'
    $old_status = $_POST['old_status']; // 'Requested'
    $new_status = $_POST['new_status']; // 'Rejected'
    $old_status_id = $_POST['old_status_id']; // '6'
    $new_status_id = $_POST['new_status_id']; // '3'
    $key = $_POST['key']; // merchant key
    $time = $_POST['ts']; // UNIX timestamp
    if (!empty($_POST['sign'])) {
        $sign = $_POST['sign'];
        $arrToHash = [];
        ksort($_POST);
        foreach ($_POST as $field => $value) {
            if ($field == 'sign' || $value === null) {
                continue;
            }
            $arrToHash[] = $field.':'.$value;
        }
        $hash = md5(implode(':', $arrToHash).':'.'_MERCHANT_SECRET_');
        if ($hash == $sign) {
            // sign correct - any needed actions further
        } else {
            // wrong sign - any needed actions further
        }
    } else {
        // no sign - any needed actions further
    }
}

Load from added bank / crypto

if (!empty($_POST)) {
    $Type = $_POST['Type']; // 'b2a'
    $status = $_POST['status']; // 'success' or 'fail'
    $reference_number = $_POST['reference_number']; // reference number
    $account_id = $_POST['account_id']; // account ID
    $amount = $_POST['amount']; // amount
    $currency = $_POST['currency']; // currency
    $settled_amount = $_POST['settled_amount']; // settled amount
    $settled_currency = $_POST['settled_currency']; // settled currency
    $transaction_id = $_POST['transaction_id']; // transaction ID $crypto_address = $_POST['crypto_address']; // crypto_address
    if (!empty($_POST['sign'])) {
        $sign = $_POST['sign'];
        $arrToHash = [];
        ksort($_POST);
        foreach ($_POST as $field => $value) {
            if ($field == 'sign' || $value === null) {
                continue;
            }
            $arrToHash[] = $field.':'.$value;
        }
        $hash = md5(implode(':', $arrToHash).':'.'_MERCHANT_SECRET_');
        if ($hash == $sign) {
            // sign correct - any needed actions further
        } else {
            // wrong sign - any needed actions further
        }
    } else {
        // no sign - any needed actions further
    }
}

Purchase

if (!empty($_POST)) {
    $status_id = $_POST['status_id']; // 7
    $reference_id = $_POST['reference_id']; // 'ap-57fcb50701182'
    $order_id = $_POST['order_id']; // 'my_order_81815'
    $data_amount = $_POST['data_amount']; // 1.01
    $currency = $_POST['currency']; // 'USD'
    $transaction_id = $_POST['transaction_id']; // transaction ID
    $key = $_POST['key']; // merchant key
    $time = $_POST['ts']; // UNIX timestamp
    // note that transaction ID will be not empty only if status is 8 or 9
    if (!empty($_POST['sign'])) {
        $sign = $_POST['sign'];
        $arrToHash = [];
        ksort($_POST);
        foreach ($_POST as $field => $value) {
            if ($field == 'sign' || $value === null) {
                continue;
            }
            $arrToHash[] = $field.':'.$value;
        }
        $hash = md5(implode(':', $arrToHash).':'.'_MERCHANT_SECRET_');
        if ($hash == $sign) {
            // sign correct - any needed actions further
        } else {
            // wrong sign - any needed actions further
        }
    } else {
        // no sign - any needed actions further
    }
}

Wire transfer

if (!empty($_POST)) {
    $Type = $_POST['Type']; // 'mu2m'
    $status = $_POST['status']; // 'success' or 'fail'
    $status_id = $_POST['status_id']; // 3
    $reference_number = $_POST['reference_number']; // reference number
    $order_id = $_POST['custom_order_id']; // custom order id
    $account_id = $_POST['account_id']; // account ID
    $amount = $_POST['amount']; // amount
    $currency = $_POST['currency']; // currency
    $settled_amount = $_POST['settled_amount']; // settled amount
    $settled_currency = $_POST['settled_currency']; // settled currency
    $transaction_id = $_POST['transaction_id']; // transaction ID
    $key = $_POST['key']; // merchant key
    $time = $_POST['ts']; // UNIX timestamp
    if (!empty($_POST['sign'])) {
        $sign = $_POST['sign'];
        $arrToHash = [];
        ksort($_POST);
        foreach ($_POST as $field => $value) {
            if ($field == 'sign' || $value === null) {
                continue;
            }
            $arrToHash[] = $field.':'.$value;
        }
        $hash = md5(implode(':', $arrToHash).':'.'_MERCHANT_SECRET_');
        if ($hash == $sign) {
            // sign correct - any needed actions further
        } else {
            // wrong sign - any needed actions further
        }
    } else {
        // no sign - any needed actions further
    }
}

3DS submit form

    <script type="text/javascript">
        window.onload = function(e){
            document.getElementById("myForm").submit();
        }
    </script>

    <div style="display: none;">
        <form id="myForm" action="http://bank-url" method="post">
            <input type="text" name="MD" value="15633665670206" />
            <input type="text" name="PaReq" value="dGJpbWhybWM1WXA3ZytXK3ZuR3BvTGgycXBxVXNkYmRwNXA2emJqQlluK0pjSzYzZHBoNXNKS0ZxcDYxbkhmU21IV3V6Y2ZXdnM2Um5uSHJtcEtzbDl6TWo5ckN4NU9mcXN5SFpNVEtqcWFaNEwyK3kzOThiY1BXdXRpM29xK3NrYXlJdmNHamdxN2FtSTJvZ2JXOXA2VzlwcmFaanBtVm1MVEVyTFNOb3RhL3lIT0dvN0c3MllsMzBNM1ltNWl1MG1hL25LM0V5cDZZaHArWnNhSmliSXhndTdxUXdxVEFyWWFkaGEvQ2Q5S1JjS0hLcmF5VHZuMmVhT2Via3IyVXlOeDV0N0cycEoyZ29vS1p0TFdCZEkvZ2lyTE1qM1c0eTlYYzJiZkdyblY0NVkzTHdiaUd5ZEtyblcrSnRKaHJqcExBZnBlbGk2eVMxck9kcEoyTnlhNjBmNzJnaUsvR2dIYnV4TmRoc3EyNGVwNmJyY1N6cDVhdmdkeTZuNHlx" />
            <input type="text" name="TermUrl" value="http://return-url" />
            <input type="submit" value="Submit 3DS" />
        </form>
    </div>

Notation

Parameter requirement

Notation	Meaning
Y	Mandatory
N	Optional
C	Conditional

Type

Notation	Meaning
A	The abbreviation for alphabetical inputs (A-Z a-z).
AN	The abbreviation for alphanumeric inputs (0-9 A-Z a-z .!@).
AS	The abbreviation for alphabetical inputs (A-Z a-z -) and space symbol.
LIST
N	The abbreviation for numeric inputs (0-9).

Special symbols

Type of symbol	Symbol mark
Apostrophe	‘ ’ '
Bracket	( ) [ ] { } < >
Exclamation mark	!
Guillemet	« »
Quotation mark	“ ” "
Question mark	?
Solidus	/ \
Comma	,
Period	.
Plus and minus	+ -
Dash	-
Percent sign	%
Ampersand	&
At sign	@
Asterisk	*
Number sign	#
Equals sign	=
Currency sign	£ $ € ¥