Payout Host to Host

Payment registration transactions

Payout HTH

2. payout_hth

Description:
Allows the creation of payouts (outgoing payments). This endpoint simplifies regional transactions by providing a secure and seamless experience for merchants.
URL:https://api.payelu.xyz/api/v1/payments/payout_hth
 

Country Uses:

  • Argentina: Bank Transfers & DEBIN
  • Peru: Bank Transfers & Yape
  • Ecuador: Bank Transfers
  • Paraguay: Bank Transfers
  • Brazil: PIX
  • Mexico: SPEI
  • Uruguay: Bank Transfers
  • Colombia: Bank Transfers
  • Chile: Bank Transfers
  • Venezuela: Bank Transfers & PagoMóvil

Request Parameters:

Parameter
Type
Description
Requeriment
service_code
string
Service Codes list:
’BT_AR', ‘DEBIN_AR', ’BT_CL’, ’BT_PE’, ’BT_PY', ’BT_UY’ , ‘SPEI_MX’, ’PIX_BR’,
- ’YP_PE’, ’ BT_EC' , ’BT_CO’, BT_VE , PM_VE
required
amount
num
Amount to process. e.g. 123.45
required
reference
string
Merchant’s Unique ID for transaction (i.e. ‘1234567980’ or
‘INV-000001’)
required
account_bank
string
For target account.
Bank Name or Bank Code
required for service_code:
’BT_CL’, ’BT_PY’,
’BT_PE’ - ’ BT_EC' , ’BT_CO’, BT_VE ,
account_phone
string
For number target account. Cellphone number associated with service
- ’YP_PE’ , ‘PM_VE’
account_type
string
For target account (account_type). Values:
[’CBU’ ’ALIAS’]

required for service_code:
’BT_AR’
ㅤ
string
For target account (account_type). Values:
[’CC’, ’SVGS’, ‘VISTA’, ‘RUT’, ‘SLRY’]
required for service_code:
’BT_CL'
ㅤ
string
For target account (account_type). Values:
[’CLABE’]
required for service_code:
’SPEI_MX’
ㅤ
string
For target account (account_type). Values:
[’ACCOUNT_PARAGUAY’]
required for service_code:
’BT_PY’
ㅤ
string
For target account (account_type). Values:
[’ACCOUNT_COLOMBIA’]
required for service_code:
’BT_CO’
ㅤ
string
For target account (account_type). Values:
[’ACCOUNT_VENEZUELA’]
required for service_code:
’BT_VE’ ’PM_VE’

ㅤ
string
For target account (account_type). Values:
[’ACCOUNT_ECUADOR’]
required for service_code:
’BT_EC’
ㅤ
string
For target account (account_type). Values:
[’CC’, ’SVGS’, ‘EFE’]
required for service_code:
’BT_PE’ - ’YP_PE’
account
string
For target account, is the Account number.
Other behaviors:
1)For service_code ‘BT_AR’ is the ‘ALIAS’ o ‘CBU’ account.
2) For service_code ‘SPEI_MX’ is the ‘CLABE’ code.
3) For service_code ‘PIX_BR’ is the ‘chavePix’ code (CPF/CNPJ or Phone international format).
required for service_code:
’BT_AR’, ’BT_CL’, ’SPEI_MX’, ’BT_PY’, ’BT_PE’,
’PIX_BR’ - ’YP_PE’, ’ BT_EC' , ’BT_CO’, BT_VE , PM_VE
account_doc_type
string
For target account (account_doc_type). Values:
[’RUT’ ’RUN’, ‘PAS’, ’CE’]

required for service_code=
’BT_CL’
account_doc_type
string
For target account (account_doc_type). Values:
[’CI’ ; ’RIF’ ; ’PAS’

required for service_code=
’BT_VE’ ’PM_VE’
account_doc_type
string
For target account (account_doc_type). Values:
[’CC’ ; ’CE’; ’PAS’


required for service_code=
’BT_CO’
account_doc_type
string
For target account (account_doc_type). Values:
[’CI’ ; ’CIE’; ’PAS’


required for service_code=
’BT_EC’
ㅤ
string
For target account (account_doc_type). Values
[’CI’ ’PAS’, ‘CRP’, ’CRC’, ‘RUC’, ‘DNI’, ]

required for service_code=
’BT_PY’
ㅤ
string
For target account (account_doc_type). Values
[’RUC’ ’DNI’, ‘PAS’, ’CE’]

required for service_code=
’BT_PE’ - ’YP_PE’
account_doc_id
string
For target account.
Document number, TaxID, Document Code.
required for service_code=
’BT_CL’, ’BT_PY’, ’BT_PE’,
’PIX_BR’ - ’ BT_EC' , ’BT_CO’, BT_VE , ’YP_PE’ , ’PM_VE’
account_beneficiary
string
For target account. Beneficiary Name
required for service_code=
’BT_CL’, ’BT_PY’, ’BT_PE’ - ’ BT_EC' , ’BT_CO’, BT_VE ,
account_state
string
For target account. Account State.
required for service_code=
’BT_PE’
account_inter_bank_code
string
For target account. Inter_bank_code (e.g. service_code=’PE’ is cciNumber
required for service_code=
’BT_PE’

Expected Response:

Field
Type
Description
status
String
Status of the request (success, error).
data.transaction_id
String
Unique transaction identifier.
data.amount
Float
Processed amount.
data.status
String
Transaction status, e.g., COMPLETED.
data.reference
String
Merchant-provided reference ID.

Argentina BT Example Request:

request:
{
    "service_code": "BT_AR",
    "amount": 10,
    "reference": "{{payout_ref}}",
 	"account_type" : "ALIAS",
	"account" : "BARCO.PEZ.CONTROL"
}

Argentina BT Example Response:

{
    "status": "success",
    "data": {
        "transaction_id": "1cfa2295-9297-4adb-83cc-118c98b0ecbc",
        "amount": 10.0,
        "reference": "POUT-1736824740409-295gd",
        "created_at": "2025-01-14 03:19:00",
        "status": "COMPLETED"
    }
}

Argentina DEBIN Example Request:

{
    "service_code": "DEBIN_AR",
    "amount": 10,
    "reference": "{{payout_ref}}",
    "account_type" : "ALIAS",
	"account" : "BARCO.PEZ.CONTROL"
}

Argentina DEBIN Example Response:

{
    "status": "success",
    "data": {
        "transaction_id": "e89703bc-7ebf-422d-9ce2-85e9775b30a6",
        "amount": 10.0,
        "reference": "POUT-1736863415424-krw9dl",
        "created_at": "2025-01-14 14:03:34",
        "status": "COMPLETED"
    }
}

Peru BT Example Request:

{
    "service_code": "BT_PE",
    "amount": 10,
    "reference": "{{payout_ref}}",
	"account_bank" : "123",
	"account_type" : "CC",
	"account" : "123456",
	"inter_bank_code" : "cciNumber",
	"account_doc_type" : "DNI",
	"account_doc_id" : "123456",
    "payer_name" : "Carlos Gil",
    "account_state" : "LIMA"
}

Peru BT Example Response:

{
    "status": "success",
    "data": {
        "transaction_id": "a36d30bb-f8fb-4a54-a1ac-cff39c8a680c",
        "amount": 10.0,
        "reference": "POUT-1736822116172-f28hr4",
        "created_at": "2025-01-14 02:35:18",
        "status": "COMPLETED"
    }
}

Chile BT Example Request:

{
    "service_code": "BT_CL",
    "amount": 10,
    "reference": "{{payout_ref}}",
	"account_bank" : "123",
	"account_type" : "CC",
	"account" : "123456",
	"account_doc_type" : "CE",
	"account_doc_id" : "123456",
    "payer_name" : "Carlos Gil"
}

Chile BT Example Response:

{
    "status": "success",
    "data": {
        "transaction_id": "337bae4c-ae9f-442d-8397-53441588bbfb",
        "amount": 10.0,
        "reference": "POUT-1736823391036-5vf36n",
        "created_at": "2025-01-14 02:56:32",
        "status": "COMPLETED"
    }
}

Mexico SPEI Example Request:

{
    "service_code": "SPEI_MX",
    "amount": 10,
    "reference": "{{payout_ref}}",
	"account" : "12354"
}

Mexico SPEI Example Response:

{
    "status": "success",
    "data": {
        "transaction_id": "831d741a-a43b-4af9-90ee-1120db39cb09",
        "amount": 10.0,
        "reference": "POUT-1736861689178-5kjza",
        "created_at": "2025-01-14 13:34:48",
        "status": "COMPLETED"
    }
}