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
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
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 1: Mexico Bank (Payment Type 1)

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

Example 2: Argentina Bank (Payment Type 1)

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

Example 3: 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

Example 4: 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

Example 5: 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

Example 6: Colombia Bank (Payment Type 1)

{
    "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.

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

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.