Lista de Payout

Como obter detalhes da sua lista de payout.

Post

https://sandbox.transfersmile.com/api/payout/list

Este endpoint permite que você obtenha a lista de payout

Parameters

Content-Type*stringapplication/json; chartset=UTF-8
AppId*stringSeu App ID na plataforma de payout
Authorization*stringsignature, generated by SHA256($sorted_params + $app_key)

Body

start_time*stringstart_time(UTC), e.g. 2021-07-01 00:00:00
end_time*stringend_time(UTC), e.g. 2021-08-01 00:00:00
page_numintegerpaging param, número de página, deve começar a partir de 1, enquanto 0 está incorreto.
page_sizeintegerpaging param, linhas serão devolvidas, máx 1000
timestamp*integerunix timestamp, e.g. 1628512575

Responses

200Lista de Payout coletada com sucesso.
{
    "code": 200,
    "msg": "success",
    "time": 1628500091,
    "data": [
        {
            "reference_id": "custom_codexxxx",
            "transaction_id": "TS202108090705014iNqtxektRS",
            "user_name": "GUILHERME ALVES DE SOUZA",
            "bank_id": "EXXXXD", // only supported by pix payout.
            "amount": "0.6",
            "source_amount": "0.6",
            "settlement_amount": "0.6",
            "source_currency": "BRL",
            "arrival_amount": "0.57",
            "arrival_currency": "BRL",
            "exchange_rate": "1",
            "tax": "0.02",
            "fee": "0.01",
            "fee_user": "beneficiary",
            "transaction_status": "PROCESSING",
            "create_time": 1625142259,
            "update_time": 1625142261
        },
        ... ...
    ]
}
400Request expirou
{
    "code": 4001009,
    "msg": "request has expired",
    "time": 1628512773,
    "data": {}
}

Exemplo

curl --location --request POST 'https://sandbox.transfersmile.com/api/payout/list' \
--header 'AppId: 94FAC**********************68548' \
--header 'Authorization: d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302' \
--header 'Content-Type: application/json' \
--data-raw '{
    "start_time": "2021-07-01 00:00:00",
    "end_time": "2021-08-01 00:00:00",
    "page_size": 5,
    "page_num": 1, // should start from the number 1, while 0 is incorrect.
    "timestamp": 1628512575
}'

Tips

Importante: 94FAC**********************68548 é o App Id de teste transfersmile para o ambiente de sandbox, e d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302 é o token de autorização associado ao App Id de teste.

Tips

Nota: O page_num deve começar a partir do número 1, enquanto 0 está incorreto.