Skip to main content

Payouts to USA

Payout parameters

NameMandatoryTypeDescription
payment_method+objectPayout data
 type+stringValue: bank_account
 bank_account+objectBank account
  system_type+stringValue: global
  global+objectBank account details
   description+stringPurpose of remittance for the payout. This description should match the classification given in How to specify the remittance purpose
   bank_account_number+stringBank account number for the payout
   account_type+stringAccount type. Valid values: CHECKING, SAVINGS
   routing_code+stringABA Routing Transfer Number
participant_details+objectInformation on the payout participants
 recipient+objectRecipient details
  bank_name+stringImportant: the bank name must be chosen from the List of supported banks, otherwise the payout will fail
  currency+stringRecipient's currency in ISO 4217 format. Case insensitive
  country_iso3+stringRecipient's country code (ISO-3166-1 alpha-3)
  first_name+stringRecipient's first name. Important: if the name is passed incorrectly, the recipient bank may not accept the payout
  last_name+stringRecipient's last name. Important: if the name is passed incorrectly, the recipient bank may not accept the payout
  address_line+stringRecipient's street address (max. 256 characters)
  city+stringRecipient's city
  postal_code+stringRecipient's postal code
  state+stringRecipient's state
 sender+objectSender details
  company_name+stringSender company name. Limited to 100 characters, cannot contain digits only
  registration_number+stringSender company registration number (max. 64 characters)
  country_iso3+stringSender’s country code (ISO-3166-1 alpha-3)
  address_line+stringSender's address (max. 256 characters)
  city+stringSender's city
  code+stringSender company registration number
  postal_code- (mandatory for senders from Canada only)stringPostal code
  state- (mandatory for senders from Canada only)stringState
amount_details+objectPayout amount details
 amount+intPayout amount in decimal format. The value must be greater than zero. If you are sending 100 USD, write 10000
 currency+stringISO 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": {
"bank_account_number": "bank account number",
"routing_code": "routing transfer number",
"account_type": "CHECKING",
"description": "purpose of remittance"
}
}
},
"participant_details": {
"recipient": {
"address_line": "Recipient's address",
"bank_name": "All Banks United States of America",
"city": "City name",
"currency": "USD",
"country_iso3": "USA",
"first_name": "John",
"last_name": "Johnson",
"postal_code": "postal code",
"state": "state"
},
"sender": {
"company_name": "Company name",
"registration_number": "1234567890",
"country_iso3": "USA",
"city": "City name",
"address_line": "Sender's address",
"code": "1234567890"
}
},
"amount_details": {
"amount": 1000,
"currency": "usd"
}
}'

List of supported banks

CountryCurrencyBank
USAUSDAll Banks United States of America