Create a payout

Create a payout request

Request

Header Params

Body Params application/json

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.sufupayment.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

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"
}