logo
API Reference
No results found.
CARD
Request a card token
post
Make a charge or deferred charge
post
Void a transaction
delete
Refund a transaction
delete
Request deferred options
get
Pre-authorize payments
post
Capture a pre-authorized payment
post
Bin Info
get
Validate OTP
post
Card Subscriptions
Request a subscription token
post
Update a subscription card data
put
Make a charge on a subscription
post
Cancel a subscription
delete
Update a subscription
patch
Add a temporary charge or discount
put
Create a subscription
post
Pre-authorize payments
post
Capture a pre-authorized payment
post
Get Subscription Info
get
Transfer In
Get Bank List
get
Request a Transfer In token
post
Init Transaction
post
Get Status
get
Transfer Out
Get Bank List
get
Request a Transfer Out token
post
Init Transaction
post
Get Status
get
Void a transaction
delete
CASH IN
Request a cash in token
post
Init Transaction
post
Transaction Status
get
Update a cash in transaction
patch
Delete a cash in transaction
delete
Cash Out
Request a cash out token
post
Init Transaction
post
Transaction Status
get
Update a cash out transaction
patch
Delete a cash out transaction
delete
Card Async
Request a card async token
post
Init Transaction
post
Get Status
get
Async Card Subscriptions
Request a token
post
Init an async card subscription
post
SmartLinks v2
Create a Smartlink
post
Get a Smartlink
get
Delete a smartlink
delete
Update a Smartlink
patch
Analytics
Get transactions list
get
Gateway Status
Get gateway status
get
Commissions
Get Commission Configuration
post
PAYMENT CREDENTIALS
Create a credential
post
Search credentials
post
Advanced search
post
Activate or deactivate
patch
Delete credential
delete
Update credential
patch
Regenerate a credential
patch
Models
Amount
BadRequestResponse
Billing Address
ChargesVoidCardResponse
ContactDetails
Currency
ErrorResponse
GetConfigurationRequest
InvalidBinResponse
Language
Metadata
Promotions
Shipping Address
Subscription
SubscriptionAdjustmentRequest
SubscriptionUpdate
UnexpectedErrorResponse
extraTaxes
Powered by Stoplight
post

/payouts/cash/v1/tokens

Request a cash out token that can later be used to initialize the transaction

Request Parameters

2 Headers

Request Body

1 Example
Schema
object
name
string

User’s full name

1 validation + required
lastName
string

First and second last name

1 validation + required
documentNumber
string
1 validation + required
documentType
string
  • CC: Identity Document
  • NIT: Tax Id number in Colombia
  • CE: Foreing resident card in Colombia and Peru
  • TI: Identity Card in Colombia
  • PP: Passport
  • RUC: Tax Id number in Ecuador and Peru
  • CURP: Unique Population Registry Code in Mexico
  • RFC: Tax Id number in Mexico
  • RUT: Tax Id number in Chile
  • DNI: Identity Document in Peru
  • PAS: Passport in Peru
1 validation
email
string
totalAmount
number
required
currency
string
1 validation + required
description
string

A description of the payment

phoneNumber
string

Responses

201400
1 Example
Schema
object
token
string

Send a Test Request

SettingsHeaders [2]BodyCode Generation
Send requests directly from the browser (CORS must be enabled)
$$.env
No $$.env variables are being used in this request.