Status do Payout

Obter Status do Payout

POST https://sandbox.transfersmile.com/api/payout/status

This endpoint allows you to get payout status.

Headers

Name	Type	Description
Content-Type*	string	application/json; charset=UTF-8
AppId*	string	Obtenha o AppId no dashboard
Authorization*	string	assinatura, gerada por SHA256($sorted_params + $app_key)

Request Body

Name	Type	Description
payout_id	string	pagsmile transaction id, payout_id ou custom_code necessário.
custom_code	string	merchant custom_code, payout_id ou custom_code necessário.

200 sucesso

{
    "code": 200,
    "msg": "success",
    "time": 1628497163,
    "data": {
        "payout_id": "TPO2108090705014iNqtxektRS",
        "custom_code": "custom_code17902976588800",
        "status": "PAID",
        "description": "success"
    }
}

400 custom_code or payout_id necessário

{
    "code": 400,
    "msg": "invalid parameters",
    "time": 1628497751,
    "data": {
        "error": "custom_code or payout_id required"
    }
}

500 system error

{
    "code": 500,
    "msg": "system error",
    "time": 1628497751,
    "data": {
        "error": "system error"
    }
}

Status do Payout

Status	Descrição
IN_PROCESSING	status inicial após o envio
PROCESSING	processamento bancário
PAID	payout terminado com sucesso
REJECTED	payout rejeitado pelo banco
REFUNDED	payout reembolsado pelo banco

Até agora, ambas as carteiras SPEI & Pagsmile suportam o status REFUNDED.

Exemplo

curl --location --request POST 'http://sandbox.transfersmile.com/api/payout/status' \
--header 'AppId: 94FAC**********************68548' \
--header 'Authorization: d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302' \
--header 'Content-Type: application/json' \
--data-raw '{
    "payout_id": "TPO2108090705014iNqtxektRS",
    "custom_code": "custom_code17902976588800"
}'

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