Payin Host to Host

Payment registration transactions

Payin Host2Host.

1. payin_hth

Description:
Allows the creation of pay-ins (incoming payments). Tailored for specific regional preferences, our unified API empowers users to conduct diverse transactions securely.
URL:https://api.payelu.xyz/api/v1/payments/payin_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
 

Request Parameters:

Parameter
Type
Description
Requeriment
service_code
string
Service code, list:
'BT_AR', 'DEBIN_AR', 'BT_CL', 'BT_PY', 'BT_PE', 'PIX_BR', 'BT_UY', - 'SPEI_MX'
'YP_PE', 'BT_EC', 'BT_CO', 'BT_VE', 'PM_VE
required
amount
num
Amount to process. (e.g. 123.34)
required
reference
string
Merchant’s Unique ID for transaction (e.g. ‘1234567980’ or ‘INV-000001’)
required
payer_doc_id
string
Payer's tax identification number.
required for service_code:
BT_AR’, ’BT_CL', ’PIX_BR’ - 'YP_PE', 'BT_EC', 'BT_CO', 'BT_VE', 'PM_VE
payer_name
string
Payer’s full name
required for service_code:
BT_PE’, ’BT_PY’,
BT_UY’ - 'YP_PE', 'BT_EC', 'BT_CO', 'BT_VE', 'PM_VE
account_type
string
For debit source account.
Account type , Values:
[’CBU’ or ’ALIAS’]
required for service_code:
DEBIN_AR
account
string
For debit source account.
CBU’ number or ‘ALIAS’ reference for Pull Transaction
required for service_code:
DEBIN_AR
expired_at
string
Payment expiration datetime in UTC (ISO 8601 format)
optional

Expected Response:

Field
Type
Description
In
status
string
Status of the request (success, fail).
all services codes
data.transaction_id
string
Unique transaction identifier.
all services codes
data.amount
num
Processed amount.
all services codes
data.currency
string
Currency code, e.g., ARS.
all services codes
data.status
string
Transaction status, e.g., PENDING, COMPLETED, ERROR
all services codes
data.created_at
string
Transaction creation timestamp. ISO UTC format
all services codes
data.updated_at
string
Last updated timestamp. ISO UTC format
all services codes
data.expired_at
string
all services codes
data.target_account_bank
string
Bank to deposit
'BT_AR', 'DEBIN_AR', 'BT_CL', 'BT_PY', 'BT_PE', 'PIX_BR', 'BT_UY'
data.target_account_num
string
Account Number to deposit
'BT_AR', 'DEBIN_AR', 'BT_CL', 'BT_PY', 'BT_PE', 'PIX_BR', 'BT_UY'
data.target_account_type
string
Account Type to deposit
'BT_AR', 'DEBIN_AR', 'BT_CL', 'BT_PY', 'BT_PE', 'PIX_BR', 'BT_UY'
data.target_account_beneficiary
string
Beneficiary of Account to deposit
'BT_AR', 'DEBIN_AR', 'BT_CL', 'BT_PY', 'BT_PE', 'PIX_BR', 'BT_UY'
data.target_account_reference
string
Reference about Deposit
'BT_AR', 'DEBIN_AR', 'BT_CL', 'BT_PY', 'BT_PE', 'PIX_BR', 'BT_UY'
data.pix_br_code
string
Pix Copie e cola code.
Only for service_code=
PIX_BR

Argentina BT Example Request:

request: { "service_code": "BT_AR", "amount": 25, "reference": "{{payin_ref}}", "payer_doc_id" :"45465055" }

Argentina BT Example Response:

{ "status": "success", "data": { "transaction_id": "cfa8bd67-6112-43ae-912b-a05e35e968b1", "amount": 25.0, "currency": "ARS", "status": "PENDING", "reference": "PAY-1736824752873-1odmd", "created_at": "2025-01-14T03:19:12.523337Z", "updated_at": "2025-01-14T03:19:12.523341Z", "expired_at": "2025-01-15T03:19:12.520871Z", "target_account_bank": null, "target_account_num": "123456789", "target_account_type": null, "target_account_beneficiary": "Payelu Inc", "target_account_doc_id": "123456789", "target_account_reference": null } }

Argentina DEBIN Example Request:

{ "service_code": "DEBIN_AR", "amount": 99997, "reference": "{{payin_ref}}", "account_type" : "CBU", "account" : "11223344" }

Argentina DEBIN Example Response:

{ "status": "success", "data": { "transaction_id": "77640296-88f4-4f7d-aba1-e5e06851fd46", "amount": 99997.0, "reference": "PAY-1736863040738-5pqvn", "created_at": "2025-01-14T13:57:21.444393Z", "status": "PENDING" } }

Chile BT Example Request

{ "service_code": "BT_CL", "amount": 25, "reference": "{{payin_ref}}", "payer_doc_id" :"45465055" }

Chile BT Example Response

{ "status": "success", "data": { "transaction_id": "cfa8bd67-6112-43ae-912b-a05e35e968b1", "amount": 25.0, "currency": "CLP", "status": "PENDING", "reference": "PAY-1736824752873-1odmd", "created_at": "2025-01-14T03:19:12.523337Z", "updated_at": "2025-01-14T03:19:12.523341Z", "expired_at": "2025-01-15T03:19:12.520871Z", "target_account_bank": null, "target_account_num": "123456789", "target_account_type": null, "target_account_beneficiary": "Payelu Inc", "target_account_doc_id": "123456789", "target_account_reference": null } }

Peru BT Example Request

{ "service_code": "BT_PE", "amount": 99997, "reference": "{{payin_ref}}", "payer_name" : "Carlos Herrera" }

Peru BT Example Response

{ "status": "success", "data": { "transaction_id": "f6cc3da7-fc07-4db2-b58b-391b7abaf37b", "amount": 99997.0, "currency": "PEN", "status": "PENDING", "reference": "PAY-1736820647779-r6330g", "created_at": "2025-01-14T02:10:47.410269Z", "updated_at": "2025-01-14T02:10:47.410272Z", "expired_at": "2025-01-15T02:10:47.407853Z", "target_account_bank": null, "target_account_num": "123456789", "target_account_type": null, "target_account_beneficiary": null, "target_account_doc_id": null, "target_account_reference": null } }

Mexico SPEI Example Request

{ "service_code": "SPEI_MX", "amount": 100, "reference": "{{payin_ref}}", "expired_at" : "2025-01-14T23:59:59Z" }

Mexico SPEI Example Response

{ "status": "success", "data": { "transaction_id": "55e51aa4-bfcf-4d0a-9e80-fc32860f8d6b", "amount": 100.0, "currency": "MXN", "status": "PENDING", "reference": "PAY-1736861826586-65txut", "created_at": "2025-01-14T13:37:05.518548Z", "updated_at": "2025-01-14T13:37:05.518554Z", "expired_at": "2025-01-14T23:59:59Z", "clabe": "123456789" } }