Pay Out

Chame a API de pagamentos para solicitar saque para seu cliente.

GET /payout/{id}

Chamada

curl -v --location --request GET 'https://api-uat.jumppag.com/payout/{id}' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \'

Resposta

{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": {
        "id": "f569c39c-71c2-44a2-8f95-d5840886bbe3",
        "customer_id": "d9e9557e-11a5-49df-b51b-d513a7f5b348",
        "transaction_id": "22dd9e47-97c7-4982-af50-3d3e0782d054",
        "amount": "980",
        "currency": "BRL",
        "status": "pending",
        "created_at": "2024-11-11T19:08:20.000000Z",
        "updated_at": "2024-11-11T19:08:20.000000Z"
    }
}

Detalhes da resposta

Parâmetro	Descrição
id	O pagamento criado pela solicitação tornou-se um identificador único.
customer_id	O ID do cliente armazenado em sua plataforma para identificação futura.
transaction_id	O id da transação gerada na sua plataforma.
amount	O valor que o cliente especificou ao iniciar a transação.
currency	O tipo de moeda em que o valor será creditado.
status	O status atual do pagamento. Estes são os nossos status: pending, success, failed, onhold, returned,refunded
created_at	A data e a hora em que a transação foi criada.
updated_at	A data e a hora em que a transação foi atualizada com o novo status.

GET /payouts

Chamada

# Without parameters

curl -v --location --request GET 'https://api-uat.jumppag.com/payouts' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \'

# With parameters

curl -v --location --request GET 'https://uat-api.jumppag.com/payouts?limit=1&order=id,desc' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \'

Detalhes dos parâmetros

limit

integer min: 1 | max: 40

O número de itens a serem retornados na resposta.

page

integer min: 1 | max: 9999999

O número da página que indica qual conjunto de itens será retornado na resposta. Então, a combinação de page=1e limit=20retorna os primeiros 20 itens. A combinação de page=2e limit=20retorna os itens 21 a 40.

sort

string Format: item,(asc|desc)

Classifica os itens na resposta por filtro em ordem crescente ou decrescente. Por exemplo: sort=id,desc (Esta combinação retorna uma lista em ordem decrescente com base no id.)

start_time

string Internet date and time format

A data e hora de início para o intervalo a ser exibido na resposta, no formato de data e hora da Internet . Por exemplo: start_time=2021-09-05T11:00:00Z.

end_time

string Internet date and time format

A data e hora de término para o intervalo a ser exibido na resposta, no formato de data e hora da Internet . Por exemplo: end_time=2021-09-05T11:00:00Z.

customer_id

string min: 1 | max: 255

Classifica os itens na resposta procurando pelo customer_id que foi fornecido pelo seu sistema.

transaction_id

string

Classifica os itens na resposta procurando pelo transaction_id que foi fornecido uma vez pelo seu sistema. Para obter vários transaction_id, envie cada transaction_id separando por vírgula (,). Por exemplo:8fecdfcc-4e4d-11ee,8fece5ee-4e4d-11ee, d42953be-4e4d-11ee

Resposta

{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": [
        {
            "id": "897c9e20-1262-4679-a850-403d37b2a727",
            "customer_id": "d9e9557e-11a5-49df-b51b-d513a7f5b348",
            "transaction_id": "22dd9e47-97c7-4982-af50-3d3e0782d054",
            "amount": "980",
            "currency": "BRL",
            "status": "pending",
            "created_at": "2024-11-11T19:08:20.000000Z",
            "updated_at": "2024-11-11T19:08:20.000000Z"
        },
        {
            "id": "f569c39c-71c2-44a2-8f95-d5840886bbe3",
            "customer_id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "transaction_id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "amount": "300",
            "currency": "BRL",
            "status": "pending",
            "created_at": "2024-11-11T19:08:20.000000Z",
            "updated_at": "2024-11-11T19:08:20.000000Z"
        }
    ]
}

Detalhes da resposta

Parâmetro	Descrição
id	O pagamento criado pela solicitação tornou-se um identificador único.
customer_id	O ID do cliente armazenado em sua plataforma para identificação futura.
transaction_id	O id da transação gerada na sua plataforma.
amount	O valor que o cliente especificou ao iniciar a transação.
currency	O tipo de moeda em que o valor será creditado.
status	O status atual do pagamento. Estes são os nossos status: pending, success, failed, onhold, returned,refunded
created_at	A data e a hora em que a transação foi criada.
updated_at	A data e a hora em que a transação foi atualizada com o novo status.