Skip to main content
GET
/
v1
/
integrations
/
cashout
/
{id}
Consultar saque
curl --request GET \
  --url https://api.axnpay.com.br/v1/integrations/cashout/{id} \
  --header 'Authorization: Bearer <token>'
{
  "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "PENDING",
  "type": "CASHIN",
  "source": "<string>",
  "origin": "API",
  "amount": 123,
  "feeAmount": 123,
  "finalAmount": 123,
  "description": "<string>",
  "productName": "<string>",
  "pixCode": "<string>",
  "pixKeyType": "CPF",
  "pixKey": "<string>",
  "clientName": "<string>",
  "clientEmail": "<string>",
  "clientPhone": "<string>",
  "clientCpf": "<string>",
  "externalId": "<string>",
  "endToEndId": "<string>",
  "receiptUrl": "<string>",
  "transactionDate": "2023-11-07T05:31:56Z",
  "paidAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}
Consulta um saque por transactionId (UUID) ou id inteiro legado.

Authorizations

​
Authorization
string
header
required

Use sua secret key: Bearer sk_live_prod_...

Path Parameters

​
id
string
required

Response

Saque encontrado

​
transactionId
string<uuid> | null
​
status
enum<string>
Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED,
REVERSED,
CANCELLED,
CHARGEBACK
​
type
enum<string>
Available options:
CASHIN,
CASHOUT,
INFRACTION
​
source
string
​
origin
enum<string>
Available options:
API,
PAINEL,
APP
​
amount
number
​
feeAmount
number
​
finalAmount
number
​
description
string | null
​
productName
string | null
​
pixCode
string | null
​
pixKeyType
enum<string>
Available options:
CPF,
CNPJ,
EMAIL,
PHONE,
EVP
​
pixKey
string | null
​
clientName
string | null
​
clientEmail
string | null
​
clientPhone
string | null
​
clientCpf
string | null
​
externalId
string | null
​
endToEndId
string | null
​
receiptUrl
string | null
​
transactionDate
string<date-time> | null
​
paidAt
string<date-time> | null
​
createdAt
string<date-time> | null
​
updatedAt
string<date-time> | null