Get Payment Templates

Get Payment Method Templates

This API retrieves the template details for various payment methods based on the provided payment method ID.

Endpoint Information

• Request Header: X-BH-TOKEN: ******

• Request Method: GET

• Request Path: /v2/payments/templates

• Authorization Required: Yes

Query Parameters

• paymentId: (int) The ID of the payment method.

Authorization

This request requires authorization.

Payment ID Lists

Payment ID	Name	Type
58	Automated SPEI - Arcus	Automatic
105	SPEI - FINCO PAY	Automatic
63	Automated Bank Transfer (Argentina)	Automatic
68	PSE/ACH	Automatic
77	SWIFT (HK)	Automatic
78	CHATS	Automatic
79	FPS	Automatic
81	ACH_push	Automatic
82	ACH_Virtual Account	Automatic
83	WIRE	Automatic
84	WIRE_Virtual Account	Automatic
90	Automated Pix	Automatic
95	Automated Bank Transfer(Peru)	Automatic
111	ACH Account_Cross River Bank	Automatic
113	WIRE Account_Cross River Bank	Automatic
115	SWIFT Account_Cross River Bank	Automatic
19	Pix	Manual
27	Bank Transfer (Brazil)	Manual
28	Bank Transfer (Argentina)	Manual
29	Manual Bank Transfer (Mexico)	Manual
36	Mercantil	Manual
37	Bank Transfer (Venezuela)	Manual
38	Banco De Venezuela	Manual
39	Ubii Pagos	Manual
40	Banesco	Manual
41	Pago Movil	Manual
42	BNC Banco National De Credito	Manual
43	BBVA Provincial (Venezuela)	Manual
44	Bancamiga	Manual
45	Bancaribe	Manual
46	Banplus	Manual
47	Banco Activo	Manual
48	Bank Transfer (Colombia)	Manual
51	境內銀行轉賬 (台灣)	Manual
52	街口轉賬	Manual
53	LINE Pay	Manual
59	Bank Transfer (Perú)	Manual
60	Bank Transfer (Chile)	Manual
61	Manual USD Payments (CHATS)	Manual
64	Banque Msr UAE	Manual
67	Bank Transfer (Uruguay)	Manual

Response Structure

The response will include the following fields:

{
    "code": 0,                            // (number: response code)
    "msg": "",                            // (string: message)
    "data": {                             // (object: template fields)
        [string]: [string]                // (key-value pairs of template fields)
    }
}

Example Responses

Example:

Mexico Bank (58: Automated SPEI - Arcus)

{
    "code": 200,
    "msg": "SUCCESS",
    "data": {
        "CLABE number": "",
        "Account number/card": "",
        "Beneficiary Name": ""
    }
}

Mexico Bank (105: SPEI - FINCO PAY)

{
    "code": 200,
    "msg": "SUCCESS",
    "data": {
        "Account Type": "",
	"Account Number": "",
	"Beneficiary Name": "",
	"Bank Code": ""     
    }
}

Account Type: enum [clabe: VA account, debit: card account]
Bank Code: Bank code is required to be filled in only when the account type is "debit". See Mexico FINCO PAY Bank Codes.

Argentina Bank (63: Automated Bank Transfer (Argentina))

{
    "code": 200,
    "msg": "SUCCESS",
    "data": {
        "CVU number": "",
        "cuit": "",
        "Bank name": ""
    }
}

SEPA (Payment Type 2)

{
    "code": 200,
    "msg": "SUCCESS",
    "data": {
        "Bank Name": "",
        "Account Owner Name": "",
        "Account Owner Type": "",
        "Bank Country/Region": "",
        "Account Number": "",
        "Bic": "",
        "firstName": "",
        "lastName": "",
        "businessName": ""
    }
}
Account Owner Type must be either Business or Individual.
If Account Owner Type is Business, businessName is required.
If Account Owner Type is Individual, firstName and lastName are required.

Bank Country/Region is ISO 3166-1

WIRE/ACH/SWIFT (ES) (Payment Type 2)

{
    "code": 200,
    "msg": "SUCCESS",
    "data": {
        "Bank Name": "",
        "Account Owner Name": "",
        "Account Owner Type": "",
        "Bank Country/Region": "",
        "Account Number": "",
        "Routing Number": "",
        "Street Line1": "",
        "Street Line2": "",
        "City": "",
        "State": "",
        "Postal Code": "",
        "firstName": "",
        "lastName": "",
        "businessName": ""
    }
}
Account Owner Type must be either Business or Individual.
If Account Owner Type is Business, businessName is required.
If Account Owner Type is Individual, firstName and lastName are required.

Bank Country/Region is ISO 3166-1
State is ISO 3166-2

SWIFT (HK) / CHATS (Payment Type 3)

{
    "code": 200,
    "msg": "SUCCESS",
    "data": {
        "Account Owner Type": "",
        "IBAN": "",
        "Bank Name": "",
        "Bank Country/Region": "",
        "Bank Identifier": "",
        "Street": "",
        "City": "",
        "State": "",
        "Country/Region": "",
        "Postal Code": ""
        "firstName": "",
        "lastName": "",
        "businessName": ""
    }
}

Account Owner Type must be either Business or Individual.
If Account Owner Type is Business, businessName is required.
If Account Owner Type is Individual, firstName and lastName are required.

Bank Country/Region is ISO 3166-1

Colombia Bank (68: PSE/ACH)

{
    "code": 200,
    "msg": "SUCCESS",
    "data": {
        "Account Type": "",
        "Full Name": "",
        "ID Document Type": "",
        "ID Document Number": "", 
        "Bank Code": "",
        "Bank Account Number": ""
    }
}

Account Type: enum [cc: Checking Account, ch: Savings Account, dp:Electronic deposit]
ID Document Type: enum [cc: Citizenship ID, nit: Tax Identification Number, ce: Foreigner ID,  pa: Pasaporte (Passport),  ppt: Temporary Protection Permit,  ti: Identity Card, rc: Civil Registry, te: Foreigner Card, die: Foreign Identification Document, nd: No Document]
Bank Code: See Colombian Bank Codes, The bank code filled in must be one that is supported by the corresponding Account Type.

Brazil Bank (90: Automated Pix)

{
    "code": 200,
    "msg": "SUCCESS",
    "data": {
        "Pix Type": "",
        "Pix Key": ""
    }
}

Pix Type: enum [CPF:11 digits, CNPJ:14 digits, EMAIL:email, PHONE: 10-11 digits, RANDOM_KEY: with "-"]

Peru Bank (95: Automated Bank Transfer(Peru))

{
    "code": 200,
    "msg": "SUCCESS",
    "data": {
       "Bank Name": "",
       "Account Type": "",
       "Account Number": "",
       "CCI Number": "",
       "Email": "",
       "Identification Type": "",
       "Identification Number": "",
       "Name": "",
       "Phone Number": ""
    }
}

Colombia Bank Codes

Code	Bank	Type
1001	BANCO DE BOGOTA	cc, ch, dp
1002	BANCO POPULAR	cc, ch, dp
1006	ITAU	cc, ch
1007	BANCOLOMBIA	cc, ch, dp
1009	CITIBANK	cc, ch
1012	BANCO GNB SUDAMERIS	cc, ch
1013	BBVA COLOMBIA	cc, ch, dp
1019	SCOTIABANK COLPATRIA S.A	cc, ch
1023	BANCO DE OCCIDENTE	cc, ch
1032	BANCO CAJA SOCIAL BCSC SA	cc, ch
1040	BANCO AGRARIO	cc, ch, dp
1047	BANCO MUNDO MUJER	ch
1051	BANCO DAVIVIENDA SA	cc, ch, dp
1052	BANCO AV VILLAS	cc, ch, dp
1053	BANCO W	cc, ch
1059	BANCO DE LAS MICROFINANZAS - BANCAMIA S.A.	cc, ch
1060	BANCO PICHINCHA	cc, ch
1061	BANCOOMEVA	cc, ch, dp
1062	BANCO FALABELLA S.A.	cc, ch
1063	BANCO FINANDINA S.A.	cc, ch
1065	BANCO SANTANDER DE NEGOCIOS COLOMBIA S.A	ch
1066	BANCO COOPERATIVO COOPCENTRAL	cc, ch, dp
1067	MIBANCO S.A.	cc, ch, dp
1069	BANCO SERFINANZA S.A	cc, ch, dp
1070	LULO BANK S.A.	ch
1071	BANCO J.P. MORGAN COLOMBIA S.A.	cc, ch
1097	Dale	dp
1121	FINANCIERA JURISCOOP S.A. COMPAÑIA DE FINANCIAMIENTO	ch
1283	COOPERATIVA FINANCIERA DE ANTIOQUIA	ch, dp
1286	JFK COOPERATIVA FINANCIERA	ch
1289	COOTRAFA COOPERATIVA FINANCIERA	ch
1292	CONFIAR COOPERATIVA FINANCIERA	ch
1303	BANCO UNION S.A	ch
1370	COLTEFINANCIERA S.A	ch
1507	NEQUI	ch, dp
1551	DAVIPLATA	dp
1558	BAN100 S.A	cc, ch
1637	IRIS	ch
1801	MOVII	dp
1802	DING TECNIPAGOS SA	dp
1803	POWWI	dp
1804	UALA	ch
1805	BANCO BTG PACTUAL	cc
1808	BOLD CF	dp
1809	NU COLOMBIA	ch
1811	RAPPIPAY	ch, dp
1812	COINK	dp
1814	GLOBAL66	dp
1815	Alianza fiduciaria	ch
1816	Crezcamos	cc, ch

Peru Bank Codes

Code	Bank
01	BCP
02	Interbank
03	BBVA
04	Scotiabank
05	Banco de Comercio
06	BanBif (Banco Interamericano de Finanzas)
07	Banco Pichincha
08	Citibank
09	Banco GNB
10	Banco Santander
11	Banco Azteca
12	Banco Cencosud
13	ICBC PERU BANK
14	Banco de la Nación
15	Caja Cusco
16	Caja Huancayo
17	Caja Maynas
18	Caja Metropolitana
19	Caja Municipal Ica
20	Caja Sullana
21	Caja Tacna
22	Caja Trujillo

Mexico FINCO PAY Bank Codes

Code	Bank
14b392f6-5dd9-4cd9-ac51-d13c5547c137	FINCO_PAY
99d3c26a-bf2c-494e-9a39-c3359a692c38	ALBO
1d792ab5-95f3-44ba-944f-9da198f68c2e	CASHI
af8250bd-f169-480f-9dc5-0fafeb89c21b	KAPITAL
05409c64-a872-4e5e-9bac-c2a16261aea1	NAFIN
6ec6bbd5-94fa-47c4-a2c6-8ed8c3f3457b	HIPOTECARIAFED
8e04b055-b6cf-4e66-abfb-fc845d69a1bc	ACCENDOBANCO
810c88e2-8fdb-4ecd-9747-eda708b5ebe7	AMERICANEXPRES
2218cd20-0fdf-4f81-ab5c-90587b91057a	BANKOFAMERICA
6bb38026-7386-4992-8fdf-946b17b1d16c	MUFG
c4d942d0-c102-48ef-9756-532266183856	JPMORGAN
9d989796-0be4-4466-a213-61a27cdfcfaf	BMONEX
b9eae957-344c-4169-8c41-e189d3f2c74a	VEPORMAS
b2438e53-33bd-456e-937a-24e59b65fb35	DEUTSCHE
fe025a91-37ea-4869-bd68-687fd63ab6a3	CREDITSUISSE
a832542e-5eb2-49ae-b01e-b441f0d4d1ec	AZTECA
b835e788-b8c0-497a-9ce2-f5dfeac607bd	BARCLAYS
ef51659d-6b84-4f29-a92e-e435648be5b5	COMPARTAMOS
fc9a2874-2a07-416b-ac97-cf0d8eb68101	MULTIVABANCO
a72ff745-6094-4fb0-96ae-ea86847cf9b7	ACTINVER
5dcd3410-a88a-4c7a-8c4f-390f666836f4	INTERCAMBANCO
a4f9d274-2407-4295-8136-ccd0135192d7	BANCOPPEL
522333da-cff6-40b9-943e-71da34879815	ABCCAPITAL
ce134175-ad5d-4a6b-b429-deb0f4040166	CONSUBANCO
4583c80e-f7ad-4d62-bc2f-09b1aab598b9	VOLKSWAGEN
e10fb312-0538-48f6-ab9a-fc0184563d37	CIBANCO
92acfe76-0a74-4817-83e1-3fdabe2cc89c	BBASE
505292b9-41bc-4cf8-8765-1fb75fc0a264	BANKAOOL
d2ea27c8-0b41-4ca8-b5f4-e62f97d46909	PAGATODO
082a3ea6-12a9-42ce-9716-59d98e080a0e	INMOBILIARIO
95d541a3-9000-4d43-a3b2-be3dc08e5964	DONDE
13f54258-ae13-4d1d-b470-113c66db84f6	BANCREA
50b78495-f60b-475c-be1d-5f31588f9a1b	PROGRESO
688d032b-fc6f-43b7-97a1-e75a5b718597	BANCOFINTERRA
a27f9214-00d4-4826-8e59-832daf7f41aa	ICBC
0eff7474-046f-4ea7-9cdf-4ef56427919b	SABADELL
5e80e573-7e55-474f-80e0-b2424713b2a1	BANXICO
a12c354f-d2e0-462f-8b95-49d08a5aa376	BANCOMEXT
04a2c4e7-2e1c-4235-bb0b-599215f60560	BANOBRAS
cc1cdae0-3091-40b7-80af-681fdf6a9bfd	BANAMEX
6fe813b9-3daf-4fc4-9398-82dc75e26cd0	BaBien
e01d0e74-c95e-4cfd-89bb-e664bf86e4f3	SHINHAN
3387b78c-92a2-4636-94d3-a949dcbabd00	MIZUHOBANK
4b25af05-9f6f-4d5e-aaa8-5cce5059c280	BANKOFCHINA
368ad8e9-5f7a-49c5-93b3-be799dadacd8	BANCOS
9ded667d-ad5c-4da8-aa85-acf56a14adb7	NU_MEXICO
2ab903aa-e32c-4e40-a811-684050fd5476	FOMPED
d94ebc8d-6675-4158-8dca-0937b0cff6b9	MONEXCB
ead338fc-35c6-4436-b062-b87df217a152	GBM
4354277f-e083-48ff-981f-24dae6124027	MASARI
af3a5d5d-b052-4e73-8411-69db92cab98d	VALUE
10997d0a-3ac5-494d-80b5-cede1f6cc2e4	ESTRUCTURADORES
728550ff-2c76-4cbf-8969-e488081ecdfe	VECTOR
7cbc1932-b402-406f-82e7-39ddc41246d9	MULTIVACBOLSA
4cb562f8-0a9a-4df5-8451-d01a971a2944	FINAMEX
8cf9ad29-b0db-40a5-82f4-7e3e19af8400	VALMEX
4c469adf-4e07-4a3b-8ea2-955e69516e88	PROFUTURO
a930ac56-0d84-4ca5-9340-8cf3ff93de7f	CBINTERCAM
4b62d90c-8db7-4d50-a229-265786a643f0	CIBOLSA
52c1e083-309e-4bb8-ba1f-779b6493a9ce	FINCOMUN
15d56a15-86a9-48a0-8222-34c9b482cd29	HDISEGUROS
fd852c62-0ebc-470b-a9dc-bdc2d71b174e	REFORMA
033f8743-3bc4-45d7-8bc9-7805ccedb2f9	STP
0a01916c-e09d-4834-84bd-35ce27de404f	EVERCORE
6dad109e-5163-49d2-8557-7af8b35cad2b	CREDICAPITAL
8c9f8509-2989-4a97-aeee-bc55bdea330e	KUSPIT
163a12e4-e463-45cc-a684-7f986d5f1fae	UNAGRA
4e18dd45-d4a4-491b-af9e-cb086c69f4c2	ASPINTEGRAOPC
97bce569-8fc0-4025-9c04-9860592f77fd	LIBERTAD
ea38aef5-dbe0-42ec-8870-6844cf77ba30	C.B.INBURSA
16a4f525-ef02-4018-b0ef-88a98530c2c8	CAJAPOPMEXICA
a03aa6d1-0aa2-48ad-8b7d-b4dfeeed51cb	CRISTOBALCOLON
2459cecf-7841-4cf1-a98a-af9bf6984f92	CAJATELEFONIST
c9bff5ba-8f00-4743-83ec-f62af901a1d9	TRANSFER
0f0ab913-cfdb-4b11-b0c7-4c2b2bac9024	FONDO(FIRA
31e3cec1-d95c-4849-92ff-36c9944f91cc	CREDICLUB
d028742d-5cbe-4add-8518-718b840d023a	XXI-BANORTE
429d2ddc-e369-4438-a393-dbfb44e4d635	TECREEMOS
55196e15-c27f-40cd-a824-c28fdc0ed49a	SCPROMYOP
7dbf5a21-9dfd-4a71-8dd5-7832681dd6a0	CAPITALACTIVO
cf3d6099-5bdd-4738-b3a5-2bf7f127d33e	BURSAMETRICA
48a881e1-95ab-44bb-9f69-fd1ae6ade6ad	ARCUS
0b0e321e-fd89-4af9-a5c9-e3f030874646	FND
71db3f6f-0da8-4455-8e6f-1caea04223c0	CLSBANK
86107256-75dc-4429-ba6c-de5ae71e75fb	INDEVAL
5e02554c-4471-4d21-9f6e-5c7b0d754443	BanCobro_R
b9133baa-8e87-4162-bcf9-223ec4d297a5	BanCobro
481bdbde-7e47-43d9-8a30-bdd0968c40b1	BanCobro
e1adef4c-5368-41bb-92f2-7dc6ec2a6465	Validador
912f9702-f480-4f10-acec-788119e01d88	BANAMEX
e4e7f75c-4f61-4bce-b411-a5509347d755	BBVABANCOMER
0997b675-5230-4752-ae14-cff991d9f6c3	SANTANDER
89bfe0b7-ccd2-4f2d-93ef-472a62a1da45	HSBC
ec7f37e2-4a5d-4df7-9a0d-17200497a603	BANORTE
daa62e35-19e4-4b39-a99c-2ea611cf0476	AZTECA
67ee7fff-258f-4bd6-888c-7ff4d4c2477a	BANJERCITO
5ad49c1d-bff3-4b00-8bc5-32df6cb1cd2c	BBVABANCOMER
93e25084-52b2-4c4e-bfd3-39b531f9fae1	SANTANDER
1aa2cc10-84ba-453e-adae-9edcd9232847	HSBC
bbc556be-0cae-4907-aff8-9851774949f3	BAJIO
538aeb53-f5f7-4eea-9747-035c6fc80e3a	INBURSA
bdb58e56-a7d4-4fcd-b32c-ed780a9a23d0	MIFEL
631b3a6a-71fc-43dc-a483-7ea6ca46a7ed	SCOTIABANK
a9151de7-393f-4ea1-a897-92dd158f3e25	BANREGIO
2ef06d9b-0739-40fe-81c2-4a88bdd7e939	INVEX
9bdd8ac7-b628-41c7-b93a-123d09378878	BANSI
223ae9ee-47ff-4b4f-a48d-60f1c9893dfe	AFIRME
1ffb6b3b-1e93-407a-b5ec-cbb1139c1898	BANORTE
d3f867b9-9f59-46f8-b937-050d30d311bb	FONDEADORA
f34c6d1c-5204-41a4-adc0-7440cd1e8ea9	TESORED
cdf6384e-a8bc-423a-b42a-b7b488aeee83	NVIO
5d4208e6-8c5b-4654-a98a-5e35fef74c2b	MERCADO_PAGO_W
e96d092b-cc4e-4602-8665-d91bed1210f1	CUENCA
23eafe0c-833c-41ff-89c3-5dfefbe376fd	SPIN_BY_OXXO
84e4e446-f7ed-4551-9360-ad39e5a2bf06	KLAR

Notes

• The data object contains key-value pairs representing the required fields for the specified payment method.

• Ensure that valid authorization tokens are included in the request headers for successful execution.