Payouts to the United Kingdom

Payout parameters

Note that you can specify ether of the following combinations in the global parameter:

• iban, swift_bic_code
• sort_code, account_number

• If you try either of the combinations and the payout fails, try another one.
• When interacting with Revolut bank, please use the sort_code + account_number combination.

Name	Mandatory	Type	Description
payment_method/payout_details	+	object	Payout data
type	+	string	Value: bank_account
bank_account	+	object	Bank account
system_type	+	string	Value: global
global	+	object	Bank account details
description	+	string	Purpose of remittance for the payout. This description should match the classification given in How to specify the remittance purpose
account_type	+	string	Account type, use CHECKING
iban	-	string	International bank account number (without spaces)
swift_bic_code	-	string	Recipient's bank’s SWIFT or BIC code
account_number	+	string	Recipient's bank account number
sort_code	+	string	Sort code (three pairs of numbers, for example 12-34-56)
participant_details	+	object	Information on the payout participants
recipient	+	object	Recipient details
bank_name	+	string	Important: the bank name must be chosen from the List of supported banks, otherwise the payout will fail
currency	+	string	Recipient's currency in ISO 4217 format. Case insensitive
country_iso3	+	string	Recipient's country code (ISO-3166-1 alpha-3)
first_name	+	string	Recipient's first name. Important: if the name is passed incorrectly, the recipient bank may not accept the payout
last_name	+	string	Recipient's last name. Important: if the name is passed incorrectly, the recipient bank may not accept the payout
address_line	+	string	Recipient's street address
city	+	string	Recipient's city
postal_code	+	string	Recipient's postal code
state	-	string	Recipient's state
sender	+	object	Sender details
company_name	+	string	Sender company name. Limited to 100 characters, cannot contain digits only
registration_number	+	string	Sender company registration number
date_of_incorporation	+	string	Sender company incorporation date
country_iso3	+	string	Sender’s country code (ISO-3166-1 alpha-3)
code	+	string	Sender company registration number
address_line	+	string	Sender's street address
city	+	string	Sender's city
state	-	string	Sender's state
postal_code	-	string	Sender's postal code
amount_details	+	object	Payout amount details
amount	+	int	Payout amount in decimal format. The value must be greater than zero. If you are sending 100 USD, write 10000
currency	+	string	ISO 4217 currency code. Case insensitive

Example

curl -X POST \
  https://demo.smart-glocal.com/api/v1/session/start/payout \
  -H 'Content-Type: application/json' \
  -H 'X-PARTNER-PROJECT: your_project_name' \
  -H 'X-PARTNER-SIGN: signature' \
  -d'{
    "session_id": "ps_1053680",
    "payment_method": {
      "type": "bank_account",
      "bank_account": {
        "system_type": "global",
        "global": {
          "account_number": "NUMBER_VALUE",
          "sort_code": "12-34-56",
          "account_type": "CHECKING",
          "description": "purpose of remittance"
        }
      }
    },
    "participant_details": {
      "recipient": {
        "bank_name": "All Banks / GBR / UK Faster Payment",
        "currency": "gbp",
        "country_iso3": "GBR",
        "first_name": "John",
        "last_name": "Johnson",
        "address_line": "Recipient's address",
        "city": "City name",
        "postal_code": "postal code",
        "state": "state"
      },
      "sender": {
        "company_name": "Company name",
        "registration_number": "1234567890",
        "date_of_incorporation": "2011-11-11",
        "country_iso3": "USA",
        "address_line": "Sender's address",
        "city": "City name",
        "postal_code": "postal code",
        "state": "state",
        "code": "1234567890"
      }
    },
    "amount_details": {
      "amount": 1000,
      "currency": "usd"
    }
  }'

List of supported banks

Country	Currency	Bank
United Kingdom of Great Britain and Northern Ireland	GBP	All Banks / GBR / UK Faster Payment