GET
/
api
/
v1
/
payouts
/
{payout_id}
/
retrieve
curl 'https://api.sandbox.uqpay.org/api/v1/payouts/d4bfcc79-24a5-4e03-9e2a-d70fd1e3e572/retrieve' \
-H 'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203' \
-H 'x-client-id: Up1HIsjiETPXLy7gON9PMG'

{
    "code": 200,
    "message": "Success",
    "data": {
        "account_name": "graywolf",
        "beneficiary_details": {
            "beneficiary_address": {
                "country_code": "AF",
                "city": "whgre",
                "street_address": "hfgsfdsdf34543 t4g.ukiy",
                "postal_code": "643564",
                "state": "54534"
            },
            "beneficiary_bank_detail": {
                "bank_name": "adffdsg gr  rerw",
                "bank_address": "dsaf.yuy5 65",
                "bank_country_code": "AG",
                "account_holder": "rtere",
                "account_currency_code": "USD",
                "account_number": "gg4354365463",
                "iban": "",
                "swift_code": "ddddeecc",
                "clearing_system": "LOCAL",
                "routing_code_type1": "",
                "routing_code_value1": "",
                "routing_code_type2": "",
                "routing_code_value2": ""
            },
            "charge_type": "shared",
            "company_name": "dfgr",
            "country_code": "AG",
            "entity_type": "company",
            "first_name": "",
            "last_name": "",
            "payment_method": "local"
        },
        "complete_time": "0001-01-01T00:00:00Z",
        "create_time": "2023-12-12T18:21:13+08:00",
        "fee_amount": "0.9",
        "fee_paid_by": "shared",
        "payer_details": {
            "address": "buxiaode difang 999",
            "city": "singpore",
            "company_name": "",
            "country": "SG",
            "date_birth": "2005-12-07T00:00:00+08:00",
            "entity_type": "individual",
            "first_name": "dfd",
            "identification_type": "NRIC",
            "identification_value": "fasdsaf",
            "last_name": "dfd",
            "postal_code": "898989",
            "state": "9999999"
        },
        "payout_date": "2023-12-12T00:00:00+08:00",
        "payout_id": "ed6009e1-5e97-4932-84b3-c699fefb4685",
        "payout_reason": "audiovisual services",
        "payout_reference": "gg",
        "payout_status": "pending",
        "pdf_file_name": "",
        "short_reference_id": "P231212-ET80YTIF",
        "source_amount": "10",
        "source_currency": "USD",
        "target_amount": "10",
        "target_currency": "USD",
        "update_time": "2023-12-12T18:21:18+08:00"
    }
}
​
x-client-id
string
required

x-client-id.

​
x-auth-token
string
required

Bearer YOUR_TOKEN_HERE.

​
Parameters

​
payout_id
string
required

ID of the payout.

​
Response

​
code
number

Indicates whether the call was successful. 200 if successful, 400 if not.

​
message
string

Response Message. “Success” if successful, others not.

​
data
object
curl 'https://api.sandbox.uqpay.org/api/v1/payouts/d4bfcc79-24a5-4e03-9e2a-d70fd1e3e572/retrieve' \
-H 'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203' \
-H 'x-client-id: Up1HIsjiETPXLy7gON9PMG'

{
    "code": 200,
    "message": "Success",
    "data": {
        "account_name": "graywolf",
        "beneficiary_details": {
            "beneficiary_address": {
                "country_code": "AF",
                "city": "whgre",
                "street_address": "hfgsfdsdf34543 t4g.ukiy",
                "postal_code": "643564",
                "state": "54534"
            },
            "beneficiary_bank_detail": {
                "bank_name": "adffdsg gr  rerw",
                "bank_address": "dsaf.yuy5 65",
                "bank_country_code": "AG",
                "account_holder": "rtere",
                "account_currency_code": "USD",
                "account_number": "gg4354365463",
                "iban": "",
                "swift_code": "ddddeecc",
                "clearing_system": "LOCAL",
                "routing_code_type1": "",
                "routing_code_value1": "",
                "routing_code_type2": "",
                "routing_code_value2": ""
            },
            "charge_type": "shared",
            "company_name": "dfgr",
            "country_code": "AG",
            "entity_type": "company",
            "first_name": "",
            "last_name": "",
            "payment_method": "local"
        },
        "complete_time": "0001-01-01T00:00:00Z",
        "create_time": "2023-12-12T18:21:13+08:00",
        "fee_amount": "0.9",
        "fee_paid_by": "shared",
        "payer_details": {
            "address": "buxiaode difang 999",
            "city": "singpore",
            "company_name": "",
            "country": "SG",
            "date_birth": "2005-12-07T00:00:00+08:00",
            "entity_type": "individual",
            "first_name": "dfd",
            "identification_type": "NRIC",
            "identification_value": "fasdsaf",
            "last_name": "dfd",
            "postal_code": "898989",
            "state": "9999999"
        },
        "payout_date": "2023-12-12T00:00:00+08:00",
        "payout_id": "ed6009e1-5e97-4932-84b3-c699fefb4685",
        "payout_reason": "audiovisual services",
        "payout_reference": "gg",
        "payout_status": "pending",
        "pdf_file_name": "",
        "short_reference_id": "P231212-ET80YTIF",
        "source_amount": "10",
        "source_currency": "USD",
        "target_amount": "10",
        "target_currency": "USD",
        "update_time": "2023-12-12T18:21:18+08:00"
    }
}