Create a payout - Star SaaS

Create a payout request

Request

Header Params

Content-Type

string

required

Example:

application/x-www-form-urlencoded

Body Params application/json

merchant_id

string

required

Merchant Code or Merchant ID or Merchant Number

<= 7 characters

Example:

1000601

account_id

string

required

Subaccount ID or Gateway Number

<= 10 characters

Example:

1000601001

beneficiary

object

optional

Details for the beneficiary in the payment request. If beneficiary_id provided in the payment request then beneficiary should be empty

additional_info

object

optional

Additional information about the beneficiary

person_documents

array [object {3}]

optional

Beneficiary's person documents

address

object

required

Beneficiary's address details

bank_details

object

required

Beneficiary's bank account details where the payment will be credited

company_name

string

optional

Company name of the beneficiary

Example:

Complete Concrete Pty Ltd

date_of_birth

string

optional

beneficiary date of birth

Example:

1976-08-26

entity_type

string

required

Entity type of the beneficiary

Example:

COMPANY

first_name

string

optional

First name of the beneficiary

Example:

John

last_name

string

optional

Last name of the beneficiary

Example:

Walker

beneficiary_id

string

optional

A beneficiary_id previously generated by utilising the Contact API. This may be provided in place of the beneficiary section and should be empty if the beneficiary fields are provided

Example:

0123456789

client_data

string

optional

Free text field available to you; can be populated with any additional identifiers that may be required for the payment

Example:

string

fee_paid_by

string

optional

Denotes whether PAYER/BENEFICIARY will be liable for the payment fees, and it affects the actual amount the beneficiary receives

Example:

PAYER

payer

object

optional

Details for the payer in the payment request. If payer_id provided in the payment request then payer should be empty

additional_info

object

optional

Additional information about the payer

address

object

required

Payers's address details

company_name

string

optional

Company name of the payer

Example:

Complete Concrete Pty Ltd

date_of_birth

string

optional

Payer's date of birth

Example:

1976-08-26

entity_type

string

required

Entity type of the payer

Example:

COMPANY

first_name

string

optional

First name of the payer

Example:

James

last_name

string

optional

Last name of the payer

Example:

Smith

payment_amount

string

optional

Payment amount in payment_currency

Example:

10000

payment_currency

string

required

Payment amount in payment_currency

Example:

AUD

payment_date

string

optional

Date when payment should be made

Example:

2017-03-24

payment_method

string

optional

Payment method, i.e. SWIFT, LOCAL

Example:

SWIFT

reason

string

required

Reason for the payment instruction

Example:

travel

reference

string

required

A user specified reference that will be displayed to the beneficiary on the payment transaction with their bank

Example:

PMT1936398

request_id

string

required

A unique request ID specified by the client. Payout creation requests with a request_id that has been used in the past 7 days are treated as duplicated payout and cannot be processed. When you are not sure about the outcome of a payout creation request, e.g. when there are network issues or system failures such as timeout, you can try to get a payout with this request_id to find out. Note: Can be non-UUID as long as it is unique among the requests within the past 7 days.

Example:

ebe1ac96-641d-458f-a49e-bbbae9ea40c4

source_amount

string

optional

Source amount in source_currency

Example:

10000

source_currency

string

optional

Source currency, i.e. the currency that the Payer uses to fund the payment, 3-letter ISO 4217 currency code

Example:

CNY

swift_charge_option

string

optional

(For SWIFT payments only), specify who should bear SWIFT charges, either SHARED (default) or PAYER

Example:

SHARED

fund_source

string

required

fund source, Accepted values are:
Credit
Debit
Prepaid
DepositAccount
MobileMoneyAccount
Cash

Example:

DepositAccount

notify_url

string

optional

The merchant customized URL address where the payment notification will be sent to

Example:

https://www.example.com

encryption_data

string

required

Digital signature information:
encryption_data=sha256(merchant_id + account_id + request_id + payment_currency + payment_amount + sign_key);

All encryption parameters need to remove spaces before encryption.

Example

{
  "merchant_id": "1000601",
  "account_id": "1000601001",
  "beneficiary": {
    "additional_info": {
      "business_area": "Travel",
      "business_phone_number": "689342234",
      "business_registration_number": "IT593003",
      "personal_email": "john.walker@gmail.com",
      "personal_id_number": "1234567890",
      "personal_id_type": "CHINESE_NATIONAL_ID",
      "personal_mobile_number": "+861234123412",
      "personal_net_monthly_average_income": "4000",
      "personal_phone_country_code": "BR",
      "personal_phone_area_code": "18",
      "personal_fiscal_country": "BR"
    },
    "address": {
      "city": "Melbourne",
      "country_code": "AU",
      "postcode": "3000",
      "state": "VIC",
      "street": "Rua Barão do Rio Branco",
      "number": "310",
      "street_address": "15 William Street",
      "complement": "Apt. 44 A"
    },
    "person_documents": [
      {
        "file_type": "application/pdf",
        "file_url": "http://somedomain.com/document-x.pdf",
        "labels": [
          "person-cpf"
        ]
      }
    ],
    "bank_details": {
      "account_currency": "AUD",
      "account_name": "Lee Da Ming",
      "owner_document_number": "0147258369",
      "account_number": "12750852",
      "bank_account_category": "Checking,Savings,Vista,Maestra",
      "bank_branch": "Melbourne",
      "bank_country_code": "AU",
      "bank_code": "ccb",
      "bank_name": "National Australia Bank",
      "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia",
      "binding_mobile_number": "654897612345",
      "iban": "ES8023100001180000012345",
      "swift_code": "CTBAAU2S",
      "transaction_reference": "4140110135"
    },
    "company_name": "Complete Concrete Pty Ltd",
    "date_of_birth": "1976-08-26",
    "entity_type": "COMPANY",
    "first_name": "John",
    "last_name": "Walker"
  },
  "beneficiary_id": "0123456789",
  "client_data": "string",
  "fee_paid_by": "PAYER",
  "payer": {
    "additional_info": {
      "business_registration_number": "EU300503",
      "business_registration_type": "Partnership",
      "external_id": "1234567890",
      "personal_email": "james.smith@google.com",
      "personal_id_number": "1234567890",
      "job": "housewife"
    },
    "address": {
      "city": "Melbourne",
      "country_code": "AU",
      "postcode": "3000",
      "state": "VIC",
      "street_address": "15 William Street"
    },
    "company_name": "Complete Concrete Pty Ltd",
    "date_of_birth": "1976-08-26",
    "entity_type": "COMPANY",
    "first_name": "James",
    "last_name": "Smith"
  },
  "payment_amount": "10000",
  "payment_currency": "AUD",
  "payment_date": "2017-03-24",
  "payment_method": "SWIFT",
  "reason": "travel",
  "reference": "PMT1936398",
  "request_id": "ebe1ac96-641d-458f-a49e-bbbae9ea40c4",
  "source_amount": "10000",
  "source_currency": "CNY",
  "swift_charge_option": "SHARED",
  "fund_source": "DepositAccount",
  "notify_url": "https://www.example.com",
  "encryption_data": "fjlkr0fdsajlfdsaoiurjlewqnfdsakfhlksanfdsa;jkldsahk3yrnfdsa"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://test-api.star-saas.com/v1/payout' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-raw '{
    "merchant_id": "1000601",
    "account_id": "1000601001",
    "beneficiary": {
        "additional_info": {
            "business_area": "Travel",
            "business_phone_number": "689342234",
            "business_registration_number": "IT593003",
            "personal_email": "john.walker@gmail.com",
            "personal_id_number": "1234567890",
            "personal_id_type": "CHINESE_NATIONAL_ID",
            "personal_mobile_number": "+861234123412",
            "personal_net_monthly_average_income": "4000",
            "personal_phone_country_code": "BR",
            "personal_phone_area_code": "18",
            "personal_fiscal_country": "BR"
        },
        "address": {
            "city": "Melbourne",
            "country_code": "AU",
            "postcode": "3000",
            "state": "VIC",
            "street": "Rua Barão do Rio Branco",
            "number": "310",
            "street_address": "15 William Street",
            "complement": "Apt. 44 A"
        },
        "person_documents": [
            {
                "file_type": "application/pdf",
                "file_url": "http://somedomain.com/document-x.pdf",
                "labels": [
                    "person-cpf"
                ]
            }
        ],
        "bank_details": {
            "account_currency": "AUD",
            "account_name": "Lee Da Ming",
            "owner_document_number": "0147258369",
            "account_number": "12750852",
            "bank_account_category": "Checking,Savings,Vista,Maestra",
            "bank_branch": "Melbourne",
            "bank_country_code": "AU",
            "bank_code": "ccb",
            "bank_name": "National Australia Bank",
            "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia",
            "binding_mobile_number": "654897612345",
            "iban": "ES8023100001180000012345",
            "swift_code": "CTBAAU2S",
            "transaction_reference": "4140110135"
        },
        "company_name": "Complete Concrete Pty Ltd",
        "date_of_birth": "1976-08-26",
        "entity_type": "COMPANY",
        "first_name": "John",
        "last_name": "Walker"
    },
    "beneficiary_id": "0123456789",
    "client_data": "string",
    "fee_paid_by": "PAYER",
    "payer": {
        "additional_info": {
            "business_registration_number": "EU300503",
            "business_registration_type": "Partnership",
            "external_id": "1234567890",
            "personal_email": "james.smith@google.com",
            "personal_id_number": "1234567890",
            "job": "housewife"
        },
        "address": {
            "city": "Melbourne",
            "country_code": "AU",
            "postcode": "3000",
            "state": "VIC",
            "street_address": "15 William Street"
        },
        "company_name": "Complete Concrete Pty Ltd",
        "date_of_birth": "1976-08-26",
        "entity_type": "COMPANY",
        "first_name": "James",
        "last_name": "Smith"
    },
    "payment_amount": "10000",
    "payment_currency": "AUD",
    "payment_date": "2017-03-24",
    "payment_method": "SWIFT",
    "reason": "travel",
    "reference": "PMT1936398",
    "request_id": "ebe1ac96-641d-458f-a49e-bbbae9ea40c4",
    "source_amount": "10000",
    "source_currency": "CNY",
    "swift_charge_option": "SHARED",
    "fund_source": "DepositAccount",
    "notify_url": "https://www.example.com",
    "encryption_data": "fjlkr0fdsajlfdsaoiurjlewqnfdsakfhlksanfdsa;jkldsahk3yrnfdsa"
}'

Responses

🟢200Success

application/json

Body

merchant_id

string

required

account_id

string

required

amount_beneficiary_receives

integer

required

amount_payer_pays

integer

required

beneficiary

object

required

additional_info

object

required

person_documents

array [object {3}]

required

address

object

required

bank_details

object

required

company_name

string

required

date_of_birth

string

required

entity_type

string

required

first_name

string

required

last_name

string

required

beneficiary_id

string

required

created_at

string

required

failure_reason

string

required

failure_type

string

required

fee_amount

integer

required

fee_currency

string

required

last_updated_at

string

required

client_data

string

required

fee_paid_by

string

required

payer

object

required

additional_info

object

required

address

object

required

company_name

string

required

date_of_birth

string

required

entity_type

string

required

first_name

string

required

last_name

string

required

payer_id

string

required

payment_amount

string

required

payment_currency

string

required

payment_date

string

required

payment_method

string

required

reason

string

required

reference

string

required

request_id

string

required

transaction_id

string

required

short_reference_id

string

required

source_amount

string

required

source_currency

string

required

status

string

required

swift_charge_option

string

required

fund_source

string

required

encryption_data

string

required

Example

{
  "merchant_id": "1000601",
  "account_id": "1000601001",
  "amount_beneficiary_receives": 99996,
  "amount_payer_pays": 10004,
  "beneficiary": {
    "additional_info": {
      "business_area": "Travel",
      "business_phone_number": "689342234",
      "business_registration_number": "IT593003",
      "personal_email": "john.walker@gmail.com",
      "personal_id_number": "1234567890",
      "personal_id_type": "CHINESE_NATIONAL_ID",
      "personal_mobile_number": "+861234123412",
      "personal_net_monthly_average_income": "4000",
      "personal_phone_country_code": "BR",
      "personal_phone_area_code": "18",
      "personal_fiscal_country": "BR"
    },
    "person_documents": [
      {
        "file_type": "application/pdf",
        "file_url": "http://somedomain.com/document-x.pdf",
        "labels": [
          "person-cpf"
        ]
      }
    ],
    "address": {
      "city": "Melbourne",
      "country_code": "AU",
      "postcode": "3000",
      "state": "VIC",
      "street": "Rua Barão do Rio Branco",
      "number": "310",
      "street_address": "15 William Street",
      "complement": "Apt. 44 A"
    },
    "bank_details": {
      "account_currency": "AUD",
      "account_name": "Lee Da Ming",
      "owner_document_number": "0147258369",
      "account_number": "12750852",
      "bank_account_category": "Checking,Savings,Vista,Maestra",
      "bank_branch": "Melbourne",
      "bank_country_code": "AU",
      "bank_name": "National Australia Bank",
      "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia",
      "binding_mobile_number": "654897612345",
      "iban": "ES8023100001180000012345",
      "local_clearing_system": "ACH",
      "swift_code": "CTBAAU2S",
      "transaction_reference": "4140110135"
    },
    "company_name": "Complete Concrete Pty Ltd",
    "date_of_birth": "1976-08-26",
    "entity_type": "COMPANY",
    "first_name": "John",
    "last_name": "Walker"
  },
  "beneficiary_id": "0123456789",
  "created_at": "2017-03-22T16:08:02+1100",
  "failure_reason": "Insufficient funds",
  "failure_type": "UNKNOWN",
  "fee_amount": 4,
  "fee_currency": "AUD",
  "last_updated_at": "2017-03-24T18:00:02+1100",
  "client_data": "string",
  "fee_paid_by": "PAYER",
  "payer": {
    "additional_info": {
      "business_registration_number": "EU300503",
      "business_registration_type": "Partnership",
      "external_id": "1234567890",
      "personal_email": "james.smith@google.com",
      "personal_id_number": "1234567890",
      "job": "housewife"
    },
    "address": {
      "city": "Melbourne",
      "country_code": "AU",
      "postcode": "3000",
      "state": "VIC",
      "street_address": "15 William Street"
    },
    "company_name": "Complete Concrete Pty Ltd",
    "date_of_birth": "1976-08-26",
    "entity_type": "COMPANY",
    "first_name": "James",
    "last_name": "Smith"
  },
  "payer_id": "string",
  "payment_amount": "10000",
  "payment_currency": "AUD",
  "payment_date": "2017-03-24",
  "payment_method": "SWIFT",
  "reason": "travel",
  "reference": "PMT1936398",
  "request_id": "ebe1ac96-641d-458f-a49e-bbbae9ea40c4",
  "transaction_id": "137493443214324327987432",
  "short_reference_id": "20170322-9F6ML2",
  "source_amount": "10000",
  "source_currency": "CNY",
  "status": "COMPLETED",
  "swift_charge_option": "SHARED",
  "fund_source": "DepositAccount",
  "encryption_data": "agatetsshry4534fs52435345345"
}