Cashout Creation Endpoint

Learn how to generate cashouts request by using our Cashout API v3 directly from your website

Cashout Request

POST https://api-stg.lime-pay.com/v3/cashout

This endpoint allows you to generate cashout requests

Headers

Name

Type

Description

Content-Type*

string

application/json

Payload-Signature*

string

Control signature

Request Body

Name

Type

Description

string

Your Lime-Pay CASHOUTS API login key

pass*

string

Your Lime-Pay CASHOUTS API pass key

external_id*

string

Unique cashout ID on the merchant end

country*

string

Country of the cashout

amount*

number

Amount of the cashout

currency

string

Currency in which the amount was specified

document_id*

string

Document ID of the beneficiary

document_type

string

Document type of the ID specified

beneficiary_name*

string

Beneficiary's name

beneficiary_lastname

string

Beneficiary's last name

string

Beneficiary's email address

phone

string

Beneficiary's phone number

bank_code

number

Beneficiary's bank code

bank_account

string

Beneficiary's bank account

bank_branch

string

Beneficiary's branch of their bank account

account_type

string

Beneficiary's account type

address

string

Beneficiary's address

city

string

Beneficiary's city

postal_code

string

Beneficiary's postal code

beneficiary_birthdate

string

Beneficiary's birthdate

notification_url*

string

URL where the notifications will be sent

comments

string

Commentaries about the cashout

on_hold

boolean

Used to mark a cashout as on hold and not process it until manually changed to pending by you

{
    "cashout_id": "8405147"
}

{
    "code": 401,
    "message": "Invalid credentials."
}

{
    "code": 303,
    "message": "Invalid bank code"
}

{
    "code": 300,
    "message": "bank_account: must not be null; Invalid Bank account"
}

Request Fields Description

Field

Format

Description

Validations

string (max length: 32)

Your Lime-Pay CASHOUTS API Key, found on the Merchant Panel by going to: Settings -> API Access. Notice there are specific Cashout credentials

pass

string (max length: 32)

Your Lime-Pay API Passphrase, found on the Merchant Panel by going to: Settings -> API Access. Notice there are specific Cashout credentials

external_id

string (max length: 100)

Unique cashout ID on the merchant end

country

string (length: 2)

Country code for the cashout in ISO 3166-1 alpha-2 code format

See country codes

amount

Big Decimal (up to 2 decimals)

Cashout amount on the currency specified

Valid number

currency

string (length: 3)

Currency code of the amount in ISO 4217 format

See valid currencies

document_id

string (max length: 40)

Beneficiary’s personal identification number

See document validations

document_type

string (maxLength: 15)

Beneficiary’s personal identification number type

See document types validations

beneficiary_name

string (max length: 100)

Beneficiary's name

String of up to 100 characters

beneficiary_lastname

string (max length: 100)

Beneficiary's last name

String of up to 100 characters

string (maxLength: 100)

Beneficiary's valid email address

Valid email address

phone

string (maxLength: 20)

Beneficiary's phone number

See phone number validations

bank_code

Integer (max length: 6)

Beneficiary's bank code

See bank codes API

bank_account

string (max length: 30)

Beneficiary's bank account number

See bank_account validations

bank_branch

string (max length: 15)

Beneficiary's bank branch number

See bank_branch validations

account_type

string (max length: 1)

Type of account

See bank_account types

address

string (max length: 255)

Beneficiary's address

String of up to 200 characters

city

string (max length: 100)

Beneficiary's city

String of up to 100 characters

postal_code

string (max length: 20)

Beneficiary's postal code

See postal_code validations

beneficiary_birthdate

string (pattern: 'YYYYMMDD')

Beneficiary's birthdate

notification_url

string (max length: 300)

To be provided if the notification URL is different from the notification URL defined on the Merchant Panel

Valid URL over HTTPS

comments

string (max length: 200)

A commentary for this cashout

String of up to 200 characters

on_hold

boolean

If the merchant wants to hold the cashout and set it to process later through the merchants panel. Default: false

[true, false]

Fields required

Each country has different requirements and therefore we ask for different fields you need to send on the requests.

Go to the Countries Validations page to check each country requirements and validations.

Last updated 2 months ago