Search Payment Method

Check the payment methods available for each of your LP accounts

Search Payment Method

GET https://api.stage.localpayment.com/api/resources/payment-methods

Search for the payment methods available for your accounts

Query Parameters

Name	Type	Description
AccountNumber*	string	Mandatory. Your Localpayment account number in which the amount will be credited. By this parameter you can get all the payments methods available for your account. In case no account is reported, the system will bring all the payment methods available in LP.

Headers

Name	Type	Description
Authorization*	string	Mandatory. JWT token in format Bearer eyJ0.... For more information about authentication, please refer to Authentication.

200 Payment method successfully retrieved.

[
    {
        "accountCode": "ACME.MEX.USD.01",
        "accountNumber": "484.840.00000003",
        "payinPaymentMethods": [
            {
                "id": 14,
                "code": "1602",
                "name": "Oxxo",
                "description": "Oxxo",
                "paymentMethodType": "Cash",
                "country": {
                    "id": 0,
                    "code": "484",
                    "name": "Mexico",
                    "isoCode3": "MEX",
                    "localCurrency": {
                        "code": "484",
                        "name": "Mexican peso",
                        "isoCode3": "MXN"
                    }
                }
            },
            {
                "id": 31,
                "code": "1606",
                "name": "BBVA",
                "description": "BBVA",
                "paymentMethodType": "BankTransfer",
                "country": {
                    "id": 0,
                    "code": "484",
                    "name": "Mexico",
                    "isoCode3": "MEX",
                    "localCurrency": {
                        "code": "484",
                        "name": "Mexican peso",
                        "isoCode3": "MXN"
                    }
                }
            },
            {
                "id": 13,
                "code": "1600",
                "name": "Visa",
                "description": "Visa",
                "paymentMethodType": "CreditCard",
                "country": {
                    "id": 0,
                    "code": "484",
                    "name": "Mexico",
                    "isoCode3": "MEX",
                    "localCurrency": {
                        "code": "484",
                        "name": "Mexican peso",
                        "isoCode3": "MXN"
                    }
                }
            },
            {
                "id": 56,
                "code": "1603",
                "name": "Visa",
                "description": "Visa",
                "paymentMethodType": "DebitCard",
                "country": {
                    "id": 0,
                    "code": "484",
                    "name": "Mexico",
                    "isoCode3": "MEX",
                    "localCurrency": {
                        "code": "484",
                        "name": "Mexican peso",
                        "isoCode3": "MXN"
                    }
                }
            }
        ],
        "payoutPaymentMethods": []
    }
]

400: Bad Request

{
    // Response
}

Search Payment Method: request & response examples

Example request

curl --location --request GET 'https://api.stage.localpayment.com/api/resources/payment-methods?accountNumber=484.840.00000003' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjQ3ODg2NDMyLCJqdGkiOiIwNmNiNjE0YzcyMTM0M2JkYTFkMDU4Y2Y2NmFlNGRkNiIsInVzZXJfaWQiOjMwLCJzdXBlcnVzZXIiOnRydWUsImlzX3N0YWZmIjpmYWxzZSwicm9sZXMiOlsiQUxMIl0sImNvdW50cmllcyI6WyJBTEwiXSwiY29tcGFueSI6IjAwMDEiLCJjbGllbnRfY29kZSI6IjAwMDEifQ.c9CwaHxnHpG2h2S76OtqiblBwfvH85o883BVHahUheM'

Example response

[
    {
        "accountCode": "ACME.MEX.USD.01",
        "accountNumber": "484.840.00000003",
        "payinPaymentMethods": [
            {
                "id": 14,
                "code": "1602",
                "name": "Oxxo",
                "description": "Oxxo",
                "paymentMethodType": "Cash",
                "country": {
                    "id": 0,
                    "code": "484",
                    "name": "Mexico",
                    "isoCode3": "MEX",
                    "localCurrency": {
                        "code": "484",
                        "name": "Mexican peso",
                        "isoCode3": "MXN"
                    }
                }
            },
            {
                "id": 31,
                "code": "1606",
                "name": "BBVA",
                "description": "BBVA",
                "paymentMethodType": "BankTransfer",
                "country": {
                    "id": 0,
                    "code": "484",
                    "name": "Mexico",
                    "isoCode3": "MEX",
                    "localCurrency": {
                        "code": "484",
                        "name": "Mexican peso",
                        "isoCode3": "MXN"
                    }
                }
            },
            {
                "id": 13,
                "code": "1600",
                "name": "Visa",
                "description": "Visa",
                "paymentMethodType": "CreditCard",
                "country": {
                    "id": 0,
                    "code": "484",
                    "name": "Mexico",
                    "isoCode3": "MEX",
                    "localCurrency": {
                        "code": "484",
                        "name": "Mexican peso",
                        "isoCode3": "MXN"
                    }
                }
            },
            {
                "id": 56,
                "code": "1603",
                "name": "Visa",
                "description": "Visa",
                "paymentMethodType": "DebitCard",
                "country": {
                    "id": 0,
                    "code": "484",
                    "name": "Mexico",
                    "isoCode3": "MEX",
                    "localCurrency": {
                        "code": "484",
                        "name": "Mexican peso",
                        "isoCode3": "MXN"
                    }
                }
            }
        ],
        "payoutPaymentMethods": []
    }
]

Payment Method Object

Payment Method Object

Property	Type	Description
accountCode	String	Your Localpayment account code in which the amount will be acredited
accountNumber	String	Your Localpayment account number in which the amount will be acredited
payinPaymentMethods	Obj<payinPaymentMethods>	Payin payment method object
payoutPaymentMethods	Obj<payoutPaymentMethods>	Payout payment method object

Example Payment Method Object

[
    {
        "accountCode": "String",
        "accountNumber": "String",
        "payinPaymentMethods": [
            {
                "code": String,
                "name": String,
                "description": String,
                "paymentMethodType": String,
                "country": {
                    "id": number,
                    "code": String,
                    "name": String,
                    "isoCode3": String,
                    "localCurrency": {
                        "code": String,
                        "name": String,
                        "isoCode3": String
                    }
                }
            }
        ],
        "payoutPaymentMethods": [
            {
                "code": String,
                "name": String,
                "description": String,
                "paymentMethodType": String,
                "country": {
                    "id": number,
                    "code": String,
                    "name": String,
                    "isoCode3": String,
                    "localCurrency": {
                        "code": String,
                        "name": String,
                        "isoCode3": String
                    }
                }
            }
        ]
    }
]

Payin/Payout Payment Method Object

Payin/Payout Payment Method Object

Property	Type	Description
code	Number	Payment method code
name	String	Payment method name
description	String	Description of the payment method
paymentMethodType	String	Type of payment method
country	Obj<country>	Country object

Country Object

Country Object

Property	Type	Description
code	String	Country code
name	String	Country name
isoCode3	String	Country name in isoCode3
localCurrency	Obj<localCurrency>	LocalCurrency Object

Local Currency Object

Local Currency Object

code	String	Payment Method code
code	String	Currency code
name	String	Currency name
isoCode3	String	Currency name in isoCode3

Payment Methods by Country

Payin Methods + SLA