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
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

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.