Payout LATAM

This endpoint allows you to initiate a payout transaction to LATAM countries with YoguPay. It is done via Bank Transfer.

PreviousPayout Ivory Coast

Last updated 4 months ago

Payout LATAM

This endpoint allows you to initiate a payout transaction to LATAM countries with YoguPay. It is done via Bank Transfer.

This endpoint assumes that you already have completed the process of account creation and that you have either a valid access token. If you have not completed this step, please review the guide that applies to your connection type.

Create a LATAM Payout

POST /

Headers

Name

Value

Content-Type

application/json

Authorization

Bearer <token>

Body

Name

Type

Description

collection_network*

string

The used

recipient_name*

string

The name of the recipient.

bank_account_number*

string

The bank account number of the recipient.

msisdn

string

The mobile number of the recipient.

dest_currency*

string

The currency in which the recipient will receive the funds.

dest_amount*

number

The amount the recipient will receive .

purpose_of_funds*

string

The purpose of the funds transfer

country_code*

string

The country code of the recipient.

reference_number*

string

A reference unique to your system

bank_code*

string

The of the recipient's bank

recipient_email

string

The email address of the recipient.

account_type*

string

The of Account

document_type*

string

The type of document used for Identification

document_id*

string

The recipients Document ID

bank_name*

string

The name of the recipients Bank

branch_code

string

The Branch Code of the Recipients Bank

Response

curl --location 'https://api.yogupay.com/payout' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTAwNzksInVzZXJuYW1lIjoiZXJyb2xvbHVuZ2FoQGxpdmUuY29tIiwiZW52aXJvbm1lbnQiOiJzdGFnaW5nIiwiaXBfYWRkcmVzcyI6Ijo6MSIsImlhdCI6MTcyOTYxMzc5MSwiZXhwIjoxNzI5NjE1NTkxfQ.eG1YyCV8G6r-GEtCTlpdSVvwFedreaslcZGVhQTFB5Q' \
--data-raw ' 
{
   
    "collection_network": "LATAM",
    "recipient_name": "YOGU LATAM",
    "bank_account_number": "123456789",
    "msisdn": "1234567890",
    "dest_currency": "COP",
    "dest_amount": 84037971,
    "purpose_of_funds": "Making payment for a service(s)",
    "country_code": "COL",
    "reference_number": "Yogupay Test",
    "callback_url": "https://sandbox.yogupay.com/api/payout-callback",
    "bank_code": "1023",
    "recipient_email": "johndoe@yogupay.com",
    "account_type": "S",
    "document_type": "NIT",
    "document_id": "1234567890",
    "bank_name": "Banco de Occidente",
    "branch_code":""
   
}

'

{
    "status": "1",
    "message": "Payout accepted for processsing"
}

{
  "error": "Invalid request"
}

PreviousPayout Ivory Coast

Last updated 4 months ago

Create a LATAM Payout

POST /

Headers

Name

Value

Content-Type

application/json

Authorization

Bearer <token>

Body

Name

Type

Description

collection_network*

string

The used

recipient_name*

string

The name of the recipient.

bank_account_number*

string

The bank account number of the recipient.

msisdn

string

The mobile number of the recipient.

dest_currency*

string

The currency in which the recipient will receive the funds.

dest_amount*

number

The amount the recipient will receive .

purpose_of_funds*

string

The purpose of the funds transfer

country_code*

string

The country code of the recipient.

reference_number*

string

A reference unique to your system

bank_code*

string

The of the recipient's bank

recipient_email

string

The email address of the recipient.

account_type*

string

The of Account

document_type*

string

The type of document used for Identification

document_id*

string

The recipients Document ID

bank_name*

string

The name of the recipients Bank

branch_code

string

The Branch Code of the Recipients Bank

Response

curl --location 'https://api.yogupay.com/payout' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTAwNzksInVzZXJuYW1lIjoiZXJyb2xvbHVuZ2FoQGxpdmUuY29tIiwiZW52aXJvbm1lbnQiOiJzdGFnaW5nIiwiaXBfYWRkcmVzcyI6Ijo6MSIsImlhdCI6MTcyOTYxMzc5MSwiZXhwIjoxNzI5NjE1NTkxfQ.eG1YyCV8G6r-GEtCTlpdSVvwFedreaslcZGVhQTFB5Q' \
--data-raw ' 
{
   
    "collection_network": "LATAM",
    "recipient_name": "YOGU LATAM",
    "bank_account_number": "123456789",
    "msisdn": "1234567890",
    "dest_currency": "COP",
    "dest_amount": 84037971,
    "purpose_of_funds": "Making payment for a service(s)",
    "country_code": "COL",
    "reference_number": "Yogupay Test",
    "callback_url": "https://sandbox.yogupay.com/api/payout-callback",
    "bank_code": "1023",
    "recipient_email": "johndoe@yogupay.com",
    "account_type": "S",
    "document_type": "NIT",
    "document_id": "1234567890",
    "bank_name": "Banco de Occidente",
    "branch_code":""
   
}

'

{
    "status": "1",
    "message": "Payout accepted for processsing"
}

{
  "error": "Invalid request"
}