Skip to main content
POST
/
v1
/
integrations
/
create-cashout
Solicitar transferencia
curl --request POST \
  --url https://api.axnpay.com.br/v1/integrations/create-cashout \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 500000.005,
  "pixKey": "<string>",
  "idempotencyKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source": "<string>",
  "amount": 123,
  "feeAmount": 123,
  "finalAmount": 123,
  "description": "<string>",
  "productName": "<string>",
  "trackingParameters": {
    "utm_source": "<string>",
    "utm_medium": "<string>",
    "utm_campaign": "<string>",
    "utm_content": "<string>",
    "utm_term": "<string>"
  },
  "pixCode": "<string>",
  "pixKey": "<string>",
  "clientName": "<string>",
  "clientEmail": "<string>",
  "clientPhone": "<string>",
  "clientCpf": "<string>",
  "externalId": "<string>",
  "gatewayId": "<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",
  "balanceImpact": true,
  "settlementMode": "<string>",
  "_info": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.axnpay.com.br/llms.txt

Use this file to discover all available pages before exploring further.

Cria um saque com taxa fixa e envia para processamento imediato na Woovi.

Authorizations

​
Authorization
string
header
required

Use sua secret key: Bearer sk_live_prod_...

Body

application/json
​
amount
number
required
Required range: 0.01 <= x <= 1000000
​
pixKey
string
required
​
pixKeyType
enum<string>
required
Available options:
CPF,
CNPJ,
EMAIL,
PHONE,
EVP
​
idempotencyKey
string<uuid>

Response

Saque criado

​
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
​
trackingParameters
object
​
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
​
gatewayId
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
​
balanceImpact
boolean
​
settlementMode
string
​
_info
string