PSE (Colombia)

This payment solution is only available in Colombia

PSE acts as an intermediary that facilitates real-time debit transactions directly from the user's bank account. This is particularly beneficial for those who are wary of credit card fraud or simply do not own one.

In this option we provide you with a URL that you will need to integrate into your front end. From there you will be able to access a banking interface where end users will be able to initiate online payments quickly and securely.

PSE

POST https://api.stage.localpayment.com/api/payin

Headers

NameTypeDescription

Authorization*

String

Mandatory. JWT token in format Bearer eyJ0... . For more information about authentication, please refer to Authentication.

Request Body

NameTypeDescription

Bank*

Object

Mandatory. Party object.Payer account data.

Bank.Code*

String

Mandatory. Bank code, according to Localpayment bank code list.

Payer*

Object

Mandatory. Party Object. Information related to the payer.

Payer.name*

String

Mandatory. Individual frist name/ company name.

Payer.type*

String

Mandatory. Possible values: COMPANY or INDIVIDUAL

Payer.lastname*

String

Mandatory for individuals / Ignored for companies.

document*

Object

Mandatory. Object.Party Object. Validate indentity document.

Document.Type*

String

Mandatory. Document types: NIT,CC,PASS,CE, IT

Document.Id*

String

Mandatory. Identity document Id, Usually numbers or combination of number qand letters

Mandatory. BankTransfer*

Object

Mandatory. Payment method details

PaymentMethod.type*

String

Mandatory. BankTransfer

Payment.code*

String

Mandatory. Select among the codes available in each country for a payin BankTransfer payment type.

NOTE: payment method code might affect the collection currency in bimonetary countries. For more info, see the side note on currency field.

Payment.Flow*

String

Mandatory. The payment method data could be embeded in the API request (DIRECT)or collected via an aditional form or plugin (REDIRECT). Currently, only DIRECT flow is allowed.

externalId*

String

Mandatory. An ID that is meaningful to you and your system. It must be unique and alphanumeric, no characters allowed.

country*

String

Mandatory. "COL" Colombia in ISOCode3 format

amount*

number

Mandatory. Amount to charge to your end user.

currency*

String

Mandatory. The currency in which the amount is expressed. It could be A) the local currency of the selected country or B) the account's currency. If A), the amount will be charged to the customer's cash payment method. If B) and it differs from the local currency, the amount specified will be credited to your account and Localpayment will perform a Foreign Exchange operation to collect the amount expressed in local currency. In bimonetary countries, paymentMethod.code resolves possible ambiguity: the payment will be executed in the currency of that specific payment method network.

accountnumber*

String

Mandatory. Your Localpayment account number in which the amount will be credited.

comment

String

Optional. A comment related to the transaction. It should be something meaningful to your business.

conceptcode*

String

Mandatory. Choose the suitable concept code from our Concept Code List. Based on our experience, the most usual are 0039 (remittances) and 0040 (corporate payments).

Payer.email

String

Optional

phone

Object

Mandatory.Party Object. Contact phone number

phone.countrycode

String

Mandatory

phone.areacode

String

Mandatory

phone.number

String

Mandatory

address

Object

Optional. Party Object Contact address

address.street

String

Optional

address.number

String

Optional

address.city

String

Optional

adress.state

String

Optional

address.country

String

Optional

address.zipcode

String

Optional

address.comment

String

Optional

merchant*

Object

Mandatory. Party Object

merchant.name

String

Mandatory. Individual first name / company name

merchant.type*

String

Mandatory. Values: COMPANY or INDIVIDUAL

externalId*

String

Mandatory. An Id that is meaningful to you and your system. Must be unique

conceptcode*

String

Mandatory. Choose the suitable concept code from our Concept Code List. Based on our experience, the most usual are 0039 (remittances) and 0040 (corporate payments).

{
    "transactionType": "PayIn",
    "externalId": "1695934794",
    "internalId": "3d0e0a7f-8826-4cdd-9a1a-976afeb2db5a",
    "paymentMethod": {
        "type": "BankTransfer",
        "code": "1936",
        "flow": "REDIRECT"
    },
    "country": "COL",
    "currency": "COP",
    "amount": 500.0,
    "accountNumber": "170.170.00000011",
    "confirmed": {
        "currency": "COP",
        "amount": 500.0,
        "fxQuote": 1.0
    },
    "payment": {
        "currency": "COP",
        "fxQuote": 1.0,
        "financingFee": 0.0,
        "amount": 500.0
    },
    "localTaxes": [],
    "withHoldings": [],
    "fees": {
        "description": "Fee",
        "currency": "COP",
        "fxSource": 4015.0,
        "fxQuote": 1.0,
        "amount": 0.0,
        "account": "170.170.00000011"
    },
    "status": {
        "code": "100",
        "description": "INPROGRESS",
        "detail": "The payin is pending the confirmation"
    },
    "merchant": {
        "type": "COMPANY",
        "name": "LocalPayment"
    },
    "payer": {
        "bank": {
            "code": "1007"
        },
        "type": "COMPANY",
        "name": "HACCL HOLDING",
        "lastname": "",
        "document": {
            "type": "NIT",
            "id": "9012754183"
        },
        "email": "admin@haccl.co",
        "phone": {
            "countryCode": "co",
            "areaCode": "57",
            "number": "573165279197"
        },
        "address": {
            "street": "CLL 127 C BIS 7B 60 ",
            "city": "BOGOTA DC",
            "state": "BOGOTA DC",
            "country": "COL",
            "comment": "TEST_Doc"
        }
    },
    "intermediaries": [],
    "wireInstructions": {
        "referenceCode": "TB7X-UHSD-5JSL"
    },
    "date": {
        "creationDate": "2023-12-05T21:16:07.692+00:00",
        "processedDate": "2023-12-05T21:16:11.1682535",
        "expirationDate": "2023-12-12T21:16:10.6082303"
    },
    "redirectUrl": "https://web-checkout.stage.localpayment.com/redirect/aHR0cHM6Ly9yZWdpc3Ryby5kZXNhcnJvbGxvLnBzZS5jb20uY28vUFNFTkYvaW5kZXguaHRtbD9lbmM9djF3Z0olMmZHd2phN0pwWDRjQ1dTJTJiallDVWVJRW94U3FqcFlROGtBT0tvN0ElM2Q",
    "errors": []
}
curl --location 'https://api.stage.localpayment.com/api/payin/' \
--header 'Authorization: Bearer {your Bearer}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "payer":
    {
        "bank":
        {
            "code": "1007"
        },
        "name": "HACCL HOLDING",
        "type": "COMPANY",
        "email": "admin@haccl.co",
        "phone":
        {
            "number": "573165279197",
            "areaCode": "57",
            "countryCode": "co"
        },
        "address":
        {
            "city": "BOGOTA DC",
            "state": "BOGOTA DC",
            "number": null,
            "street": "CLL 127 C BIS 7B 60 ",
            "comment": "TEST_Doc",
            "country": "COL",
            "zipCode": null
        },
        "document":
        {
            "id": "9012754183",
            "type": "NIT"
        }
    },
    "amount": 500,
    "capture": false,
    "comment": "Localpayment Test",
    "country": "COL",
    "currency": "COP",
    "merchant":
    {
        "name": "LocalPayment",
        "type": "COMPANY"
    },    
    "externalId": "1695934794-2024-01-04-141345562323723",
    "conceptCode": "0001",
    "creationDate": "2023-12-05T21:16:07.692+00:00",
    "accountNumber": "170.170.00000011",
    "paymentAmount": 500,
    "paymentMethod":
    {
        "code": "1936",
        "flow": "REDIRECT",
        "type": "BankTransfer"
    }  
}'
PreviousRefund PixNextQR (Bolivia)

Last updated