Create a APM payment

POST

/v1/authorise

Alternative Payment Method
When the payment method is Alternative Payment Method, the issuer_url of the corresponding payment method will be returned, you need to request the issuer_url again and redirect to the payment page of the issuer to make payment.

Request

Header Params

Body Params application/json

Example

{
    "payment_method": "string",
    "merchant_id": "701001",
    "account_id": "701001010",
    "order_no": "1726891254563",
    "currency": "USD",
    "amount": "10.36",
    "item_total": "10.00",
    "shipping": "1.00",
    "handling": "1.00",
    "tax_total": "1.00",
    "insurance": "1.00",
    "shipping_discount": "1.00",
    "discount": "1.00",
    "website": "website.com",
    "items": "huawei#,#NUM1#,#230.00#,#1#;#Test2#,#NUM2#,#290.00#,#2",
    "note": "",
    "shopper_id": "apidog1",
    "shopper_email": "apidog@gmail.com",
    "shopper_ip": "219.78.45.63",
    "shopper_phone": "13012345678",
    "shopper_level": "1",
    "first_name": "Milton",
    "last_name": "Braganza",
    "document": "",
    "birth_date": "02-02-1920",
    "billing_country": "CN",
    "billing_state": "FJ",
    "billing_city": "Xiamen",
    "billing_address": "3610  Brighton Circle Road",
    "billing_postal_code": "56376",
    "os": "Win10",
    "browser": "Mozilla/5.0 (Windows NT 10.0; WOW64) …",
    "browser_lang": "en-US",
    "time_zone": "8",
    "resolution": "1920x1080",
    "cookie_new": "billing_country=US&shopper_email=test@ company.com&time_zone=.... ",
    "cookie_old": "billing_country=US&shopper_email=test@ company.com&time_zone=.... ",
    "delivery_firstname": "Li",
    "delivery_lastname": "Han",
    "delivery_country": "CN",
    "delivery_state": "FJ",
    "delivery_city": "Xiamen",
    "delivery_district_name": "string",
    "delivery_street_name": "string",
    "delivery_address": "3610  Brighton Circle Road",
    "delivery_postal_code": "56376",
    "return_url": "string",
    "notify_url": "{{webUrl}}/v1/pages/NotifyResult.jsp",
    "custom": "",
    "device_fingerprint": "",
    "encryption_data": "{{sign}}",
    "platform_source": "Shopify",
    "device_type": "PC",
    "person": {
        "document_number": "string",
        "document_type": "string",
        "social_name": "string",
        "email": "string",
        "phone_country_code": "st",
        "phone_area_code": "string",
        "phone_number": "string",
        "birth_date": "string",
        "net_monthly_average_income": "string",
        "address_street": "string",
        "address_number": "string",
        "address_complement": "string",
        "address_postal_code": "string",
        "address_city": "string",
        "address_state": "string",
        "address_country": "st",
        "fiscal_country": "st",
        "documents": {
            "file_type": "string",
            "file_data": "string",
            "file_url": "string",
            "labels": {
                "person_bank_account_id": "string",
                "bank_account": {
                    "account_type": "string",
                    "account_number": "string",
                    "branch_number": "string",
                    "owner_document_number": "string",
                    "owner_name": "string",
                    "branch_country": "st",
                    "currency": "str",
                    "bank": {
                        "code": "string",
                        "name": "string"
                    }
                }
            }
        }
    },
    "bank_code": "string",
    "color_depth": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://test-api.sufupayment.com/v1/authorise' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-raw '{
    "payment_method": "string",
    "merchant_id": "701001",
    "account_id": "701001010",
    "order_no": "1726891254563",
    "currency": "USD",
    "amount": "10.36",
    "item_total": "10.00",
    "shipping": "1.00",
    "handling": "1.00",
    "tax_total": "1.00",
    "insurance": "1.00",
    "shipping_discount": "1.00",
    "discount": "1.00",
    "website": "website.com",
    "items": "huawei#,#NUM1#,#230.00#,#1#;#Test2#,#NUM2#,#290.00#,#2",
    "note": "",
    "shopper_id": "apidog1",
    "shopper_email": "apidog@gmail.com",
    "shopper_ip": "219.78.45.63",
    "shopper_phone": "13012345678",
    "shopper_level": "1",
    "first_name": "Milton",
    "last_name": "Braganza",
    "document": "",
    "birth_date": "02-02-1920",
    "billing_country": "CN",
    "billing_state": "FJ",
    "billing_city": "Xiamen",
    "billing_address": "3610  Brighton Circle Road",
    "billing_postal_code": "56376",
    "os": "Win10",
    "browser": "Mozilla/5.0 (Windows NT 10.0; WOW64) …",
    "browser_lang": "en-US",
    "time_zone": "8",
    "resolution": "1920x1080",
    "cookie_new": "billing_country=US&shopper_email=test@ company.com&time_zone=.... ",
    "cookie_old": "billing_country=US&shopper_email=test@ company.com&time_zone=.... ",
    "delivery_firstname": "Li",
    "delivery_lastname": "Han",
    "delivery_country": "CN",
    "delivery_state": "FJ",
    "delivery_city": "Xiamen",
    "delivery_district_name": "string",
    "delivery_street_name": "string",
    "delivery_address": "3610  Brighton Circle Road",
    "delivery_postal_code": "56376",
    "return_url": "string",
    "notify_url": "https://test-api.sufupayment.com/v1/pages/NotifyResult.jsp",
    "custom": "",
    "device_fingerprint": "",
    "encryption_data": "{{sign}}",
    "platform_source": "Shopify",
    "device_type": "PC",
    "person": {
        "document_number": "string",
        "document_type": "string",
        "social_name": "string",
        "email": "string",
        "phone_country_code": "st",
        "phone_area_code": "string",
        "phone_number": "string",
        "birth_date": "string",
        "net_monthly_average_income": "string",
        "address_street": "string",
        "address_number": "string",
        "address_complement": "string",
        "address_postal_code": "string",
        "address_city": "string",
        "address_state": "string",
        "address_country": "st",
        "fiscal_country": "st",
        "documents": {
            "file_type": "string",
            "file_data": "string",
            "file_url": "string",
            "labels": {
                "person_bank_account_id": "string",
                "bank_account": {
                    "account_type": "string",
                    "account_number": "string",
                    "branch_number": "string",
                    "owner_document_number": "string",
                    "owner_name": "string",
                    "branch_country": "st",
                    "currency": "str",
                    "bank": {
                        "code": "string",
                        "name": "string"
                    }
                }
            }
        }
    },
    "bank_code": "string",
    "color_depth": "string"
}'

Responses

🟢200OK

application/xml

Returns
The response is in XML format. Merchant needs to parse the XML response before obtain the payment result.

Body

Example

<?xml version="1.0" encoding="UTF-8"?>
    <respon>
    <merchant_id>10001001</merchant_id>
    <account_id>10001001001</account_id>
    <order_no>112343455</order_no>
    <amount>188.58</amount>
    <currency>MXN</currency>
    <issuer_url>https://sandbox.dlocal.com/collect/pay/pay/M-e55f92cb-acc9-47f2-aa60-e99819180b4c?xtid=CATH-ST-1639120320-214722374</issuer_url>
</respon>

🟠404Record not found

🟠400Invalid input

🟢200OK

Modified at 2025-06-13 08:57:50

Create a direct payment

Create a redirect (iFrame) payment