Capture

Debit Card Capture

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

Create a debit card payment order

Headers

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

Request Body

Name	Type	Description
paymentMethod*	OBJECT	Mandatory. Payment method details
paymentMethod.type*	string	Mandatory. DebitCard.
paymentMethod.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.
paymentMethod.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. Your end user's country (i.e. country in which the payment will be processed), in ISO format. Please refer to Country Codes for a full list of supported countries.
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. e.i.: SPID (USD); SPEI (MXN)
accountNumber*	string	Mandatory. Your Localpayment account number in which the amount will be credited.
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).
comment	string	Optional. A comment related to the transaction. It should be something meaningful to your business.
exchangeRateToken	string	Optional. Token provided by the Foreign Exchange service in order to use an upfront agreed exchange rate.
payer*	OBJECT	Mandatory. Party Object. Information related to the payer.
type*	string	Mandatory. Possible values: COMPANY, INDIVIDUAL
name*	string	Mandatory. COMPANY, INDIVIDUAL name
lastName	string	Mandatory forINDIVIDUAL name / Ignored for COMPANY
document*	OBJECT	Mandatory.Party Object. Valid identity document.
document.type*	string	Mandatory. Document types. Check the regonized document type list per country
document.id*	string	Mandatory. Identity document Id. Usually numbers or combination of numbers and letters.
userReference	string	Optional. Username or id in your platform.
email*	string	Mandatory.
phone	OBJECT	Optional. Party Object. Contact phone number
phone.countryCode	string	Optional.
phone.areaCode	string	Optional
phone.number	string	Optional
birthdate	string	Optional. Individual birthdate / company incorporation date. ISO 8601 format (YYYY-MM-DD)
nationality	string	Optional
address	OBJECT	Optional. Party Object. Contact address
address.street	string	Optional
address.number	string	Optional
address.city	string	Optional
address.state	string	Optional
address.country	string	Optional
address.zipCode	string	Optional. Zip code / Postal code
address.comment	string	Optional. Additional info, such as floor or apartment number.
intermediaries	array	Optional. Array of Party objects. It represents others parties in the payment chain because of the end user is not your direct customer. Take into account the array sequence: your client should be the first element, the client of your client should be the second and so on, until there are no more intermediaries.
device	OBJECT	Optional.
device.id	string	Optional. Android / iPhone device ID. Can be blank for other device types such as PC / Mac.
device.ip	string	Optional. Device IP address
device.browser	string	Optional. Browser
metaData	OBJECT	Optional. Unstructured object to record any metadata meaningful to you.
commercialData	OBJECT	Optional. Party Object. Extra information related to the goods or services traded.
lastName	string	Optional only for INDIVIDUAL type / Ignored for COMPANY.
name	string	Mandatory. COMPANY, INDIVIDUAL name
merchant	OBJECT	Mandatory. Party Object.
type	string	Mandatory. Possible values: COMPANY, INDIVIDUAL
document.type	string	Optional. Document type (related to the merchant's residence)
phone.countryCode*	string	Optional.
phone	OBJECT	Optional. Party Object. Contact phone number
email	string	Optional.
userReference	string	Optional. Username or id in your platform.
document.id	string	Optional. Identity document id. Usually numbers or combination of numbers and letters.
document	OBJECT	Optional. Party Object.
address	OBJECT	Optional. Party Object. Contact address
nationality	string	Optional.
birthdate	string	Optional. Individual birthdate / company incorporation date. ISO 8601 format (YYYY-MM-DD).
phone.number	string	Optional.
phone.areaCode	string	Optional.
address.comment	string	Optional. Additional info, such as floor or apartment number.
address.city	string	Optional.
address.number	string	Optional.
address.street	string	Optional.
address.zipCode	string	Optional. Zip code / Postal code
address.country	string	Optional.
address.state	string	Optional.
card*	OBJECT	Mandatory. Party Object. Payer deb card data.
card.name*	string	Mandatory. Cardholder name, as printed on the front of the debitcard.
card.expirationMonth*	string	Mandatory. Card expiration month. Format MM.
card.cvv*	string	Mandatory. Card Verification Value
card.number*	string	Mandatory. Card number (PAN)
card.expirationYear*	string	Mandatory. Card expiration year. Format YYYY
item.id	string	Optional. Item ID
invoice	string	Optional. Invoice reference
item	array	Optional. List of sold items
items.quantity	number	Optional. Item quantity
items.categoryId	string	Optional. Item category
items.pictureUrl	string	Optional. URL pointing to an item picture
items.description	string	Optional. Item description
item.title	string	Optional. Item title
items.unitPrice	number	Optional. Unit price
shipments.city	string	Optional. City
shipments.number	string	Optional. Number address
shipments.street	string	Optional. Street address
shipments	array	Optional. List of shipping addresses
shipments.country	string	Optional. State/Province
shipments.state	string	Optional. State/ProvinceShipping country
shipments.comment	string	Optional. Additional info
shipments.zipCode	string	Optional. Zip code
lastName	string	Optional only for INDIVIDUAL type / Ignored for COMPANY.
name	string	Optional.INDIVIDUAL/COMPANY name
type	string	Optional. Possible values: COMPANY, INDIVIDUAL
beneficiary	OBJECT	Optional. Party Object.
email	string	Optional.
document.id	string	Optional. Identity document id. Usually numbers or combination of numbers and letters.
document.type	string	Optional. Document type (related to the merbeneficiary's residence)
document	OBJECT	Optional. Party Object.

200: OK A Debit Card payin order has been successfully posted and approved.

{
    "transactionType": "PayIn",
    "externalId": "TEST10",
    "internalId": "70cf6fdb-f733-4966-9358-5fa456972a6e",
    "paymentMethod": {
        "type": "DebitCard",
        "code": "1005",
        "flow": "DIRECT"
    },
    "country": "ARG",
    "currency": "USD",
    "amount": 100.0,
    "accountNumber": "032.840.00000001",
    "confirmed": {
        "currency": "USD",
        "amount": 100.0,
        "fxQuote": 1.0,
        "exchangeRateToken": null
    },
    "payment": {
        "installment": null,
        "currency": "ARS",
        "fxQuote": 212.4939,
        "financingFee": 0.0,
        "amount": 11952.56
    },
    "localTaxes": [],
    "withHoldings": [],
    "fees": {
        "description": "Fee",
        "currency": "USD",
        "fxSource": 1.0,
        "fxQuote": 1.0,
        "amount": 2.0,
        "account": "032.840.00000001"
    },
    "status": {
        "code": "103",
        "description": "APPROVED",
        "detail": "The payin was confirmed but not credited yet"
    },
    "ticket": null,
    "qr": null,
    "beneficiary": null,
    "merchant": {
        "type": "INDIVIDUAL",
        "name": "Merchant's name",
        "lastname": "Payer's last name",
        "document": {
            "id": "123456",
            "type": "PASS"
        },
        "email": "[e-mail]",
        "phone": {
            "countryCode": "54",
            "areaCode": "11",
            "number": "98789632"
        },
        "address": {
            "street": "Street",
            "number": "938",
            "city": "city",
            "state": "state",
            "country": "country",
            "zipCode": "zipCode",
            "comment": "Add any usefull information"
        },
        "birthdate": "2000-01-01",
        "nationality": "nationality"
    },
    "payer": {
        "type": "COMPANY",
        "name": "Payer's name",
        "lastname": "",
        "document": {
            "id": "28789658",
            "type": "DNI"
        },
        "email": "[e-mail]",
        "phone": {
            "countryCode": "1",
            "areaCode": "11",
            "number": "98789632"
        },
        "address": {
            "street": "Street",
            "number": "1234",
            "city": "city",
            "state": "state",
            "country": "country",
            "zipCode": "zipCode",
            "comment": "Add any relevant information related to the payer"
        },
        "birthdate": "01/01/1990",
        "nationality": "nationality"
    },
    "intermediaries": [],
    "wireInstructions": null,
    "date": {
        "creationDate": "2022-05-19T20:40:45.929+00:00",
        "processedDate": "2022-05-19T20:40:46.742458",
        "expirationDate": "0001-01-01T00:00:00"
    },
    "card": {
        "token": "9ChmD+w4OQJaBaxMl0QHd06KHyJ7/d5wS+atAksS3TM=",
        "bin": "451766",
        "brand": "VISA",
        "country": "AR",
        "name": "Card holder name",
        "last4": "2542",
        "expirationYear": 2025,
        "expirationMonth": 11
    },
    "errors": []
}

400: Bad Request Wrong parameters (syntactic or semantic errors). The status.code might give more information about the error (see Payin status code table)

{
    "transactionType": null,
    "externalId": null,
    "internalId": null,
    "paymentMethod": null,
    "country": null,
    "currency": null,
    "amount": null,
    "accountNumber": null,
    "confirmed": null,
    "payment": null,
    "localTaxes": null,
    "withHoldings": null,
    "fees": null,
    "status": null,
    "ticket": null,
    "qr": null,
    "beneficiary": null,
    "merchant": null,
    "payer": null,
    "intermediaries": null,
    "wireInstructions": null,
    "date": null,
    "card": null,
    "errors": [
        {
            "code": "809",
            "description": "Rejected",
            "detail": "Invalid card number length"
        },
        {
            "code": "801",
            "description": "Rejected",
            "detail": "Params error card "
        },
        {
            "code": "801",
            "description": "Rejected",
            "detail": "Params error  card number, invalid format "
        }
    ]
}

Please refer to this article to learn more about the document type required for the different payment methods by country.

Examples: Debit Card payin request

To create a debit card payment order through LP api, the request body examples are detailed below.

JSON: Mandatory OBJECTS

{
    "paymentMethod":{
        "type":"DebitCard",
        "code":"1005",
        "flow":"DIRECT"
    },
    "externalId":"test_04",
    "country":"ARG",
    "amount":1005,
    "currency":"USD",
    "accountNumber":"032.840.00000001",
    "conceptCode":"0001",
    "comment":"Add any relevant information related to the transaction",

     "merchant":{
        "type":"COMPANY",
        "name":"Merchant's name",
        "lastname":"",
        "document":{
            "type":"",
            "id":""
        },
        "email":""
    },
    "payer":{
        "type":"INDIVIDUAL",
        "name":"Payer's name",
        "lastname":"Payer's last name",
        "document":{
            "id":"37895247",
            "type":"DNI"
        },
        "email":"[e-mail]"
    },
    "card":{
        "name":"Cardholder Name",
        "number":"4517660144072542",
        "cvv":"713",
        "expirationMonth":"11",
        "expirationYear":"2025",
        "installments":"1"
        
    }
}

cURL: Mandatory OBJECTS

curl --location --request POST 'https://api.stage.localpayment.com/api/payin/' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjQ5ODgxMjc4LCJqdGkiOiI4ZjFjYmIyZGU3YjQ0MmYyYmM0OTI5NzczZjFkZWZjMiIsInVzZXJfaWQiOjMwLCJzdXBlcnVzZXIiOnRydWUsImlzX3N0YWZmIjpmYWxzZSwicm9sZXMiOlsiQUxMIl0sImNvdW50cmllcyI6WyJBTEwiXSwiY29tcGFueSI6IjAwMDEiLCJjbGllbnRfY29kZSI6IjAwMDEifQ.m4bjMi0x7iCINlsljOUMPI6xVDN11-I5Bgyz42hOnaY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "paymentMethod":{
        "type":"DebitCard",
        "code":"1005",
        "flow":"DIRECT"
    },
    "externalId":"1649881245",
    "country":"ARG",
    "amount":1005,
    "currency":"USD",
    "accountNumber":"032.840.00000001",
    "conceptCode":"0001",
    "comment":"Add any relevant information related to the transaction",

     "merchant":{
        "type":"COMPANY",
        "name":"Merchant'\''s name",
        "lastname":"",
        "document":{
            "type":"",
            "id":""
        },
        "email":""
    },
    "payer":{
        "type":"INDIVIDUAL",
        "name":"Payer'\''s name",
        "lastname":"Payer'\''s last name",
        "document":{
            "id":"37895247",
            "type":"DNI"
        },
        "email":"[e-mail]"
    },
    "card":{
        "name":"Cardholder Name",
        "number":"4517660144072542",
        "cvv":"713",
        "expirationMonth":"11",
        "expirationYear":"2025",
        "installments":"1"
        
    }
}'

JSON: Complete body request

{
    "paymentMethod":{
        "type":"DebitCard",
        "code":"1005",
        "flow":"DIRECT"
    },
    "externalId":"test_04",
    "country":"ARG",
    "amount":1000,
    "currency":"USD",
    "accountNumber":"032.840.00000001",
    "conceptCode":"0003",
    "comment":"Add any relevant information related to the transaction",
    "merchant":{
        "type":"INDIVIDUAL",
        "name":"Merchant's name",
        "lastname":"Merchant's last name",
        "document":{
            "type":"PASS",
            "id":"C03007592"
        },
        "userReference":"abc123",
        "email":"[e-mail]",
        "phone":{
            "countryCode":"54",
            "areaCode":"11",
            "number":"98789632"
        },
        "birthdate":"2000-01-01",
        "nationality":"nationality",
        "address":{
            "street":"Street",
            "number":"938",
            "city":"city",
            "state":"state",
            "country":"country",
            "zipCode":"zipCode",
            "comment":"Add any usefull information"
        }
    },
    "payer":{
        "type":"INDIVIDUAL",
        "name":"Payer's name",
        "lastname":"Payer's last name",
        "document":{
            "id":"40238471",
            "type":"DNI"
        },
        "email":"[e-mail]",
        "phone":{
            "countryCode":"1",
            "areaCode":"11",
            "number":"98789632"
        },
        "birthdate":"01/01/1990",
        "nationality":"nationality",
        "address":{
            "street":"Street",
            "number":"1234",
            "city":"city",
            "state":"state",
            "country":"country",
            "zipCode":"zipCode",
            "comment":"Add any relevant information related to the payer"
        },
        "userReference":"abcdef1"
    },
    "card":{
        "name":"Card holder name",
        "number":"4517660144072542",
        "cvv":"178",
        "expirationMonth":"11",
        "expirationYear":"2025",
        "installments": 1
        
    },
    "intermediaries":[
        
    ],
    "commercialData":{
        "invoice":"",
        "items":[
            {
                "id":"",
                "title":"",
                "description":"",
                "pictureUrl":"",
                "categoryId":"",
                "quantity":"0",
                "unitPrice":"0.0"
            }
        ],
        "shipments":[
            {
                "street":"",
                "number":"",
                "city":"",
                "state":"",
                "contry":"",
                "zipCode":"",
                "comment":""
            }
        ]
    },
    "device":{
        "deviceId":"",
        "ip":"",
        "browser":""
    },
    "metaData":{
        
    }
}

cURL: Complete body request

curl --location --request POST 'https://api.stage.localpayment.com/api/payin/' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjQ5ODgxMjc4LCJqdGkiOiI4ZjFjYmIyZGU3YjQ0MmYyYmM0OTI5NzczZjFkZWZjMiIsInVzZXJfaWQiOjMwLCJzdXBlcnVzZXIiOnRydWUsImlzX3N0YWZmIjpmYWxzZSwicm9sZXMiOlsiQUxMIl0sImNvdW50cmllcyI6WyJBTEwiXSwiY29tcGFueSI6IjAwMDEiLCJjbGllbnRfY29kZSI6IjAwMDEifQ.m4bjMi0x7iCINlsljOUMPI6xVDN11-I5Bgyz42hOnaY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "paymentMethod":{
        "type":"DebitCard",
        "code":"1005",
        "flow":"DIRECT"
    },
    "externalId":"1649881024",
    "country":"ARG",
    "amount":1000,
    "currency":"USD",
    "accountNumber":"032.840.00000001",
    "conceptCode":"0003",
    "comment":"Add any relevant information related to the transaction",
    "merchant":{
        "type":"INDIVIDUAL",
        "name":"Merchant'\''s name",
        "lastname":"Merchant'\''s last name",
        "document":{
            "type":"PASS",
            "id":"C03007592"
        },
        "userReference":"abc123",
        "email":"[e-mail]",
        "phone":{
            "countryCode":"54",
            "areaCode":"11",
            "number":"98789632"
        },
        "birthdate":"2000-01-01",
        "nationality":"nationality",
        "address":{
            "street":"Street",
            "number":"938",
            "city":"city",
            "state":"state",
            "country":"country",
            "zipCode":"zipCode",
            "comment":"Add any usefull information"
        }
    },
    "payer":{
        "type":"INDIVIDUAL",
        "name":"Payer'\''s name",
        "lastname":"Payer'\''s last name",
        "document":{
            "id":"40238471",
            "type":"DNI"
        },
        "email":"[e-mail]",
        "phone":{
            "countryCode":"1",
            "areaCode":"11",
            "number":"98789632"
        },
        "birthdate":"01/01/1990",
        "nationality":"nationality",
        "address":{
            "street":"Street",
            "number":"1234",
            "city":"city",
            "state":"state",
            "country":"country",
            "zipCode":"zipCode",
            "comment":"Add any relevant information related to the payer"
        },
        "userReference":"abcdef1"
    },
    "card":{
        "name":"Card holder name",
        "number":"4517660144072542",
        "cvv":"178",
        "expirationMonth":"11",
        "expirationYear":"2025",
        "installments": 1
        
    },
    "intermediaries":[
        
    ],
    "commercialData":{
        "invoice":"",
        "items":[
            {
                "id":"",
                "title":"",
                "description":"",
                "pictureUrl":"",
                "categoryId":"",
                "quantity":"0",
                "unitPrice":"0.0"
            }
        ],
        "shipments":[
            {
                "street":"",
                "number":"",
                "city":"",
                "state":"",
                "contry":"",
                "zipCode":"",
                "comment":""
            }
        ]
    },
    "device":{
        "deviceId":"",
        "ip":"",
        "browser":""
    },
    "metaData":{
        
    }
}'

The successfully response of a Debit Card payin order is: "The payin was confirmed but not credited yet". However, after recieving that message, almost immediately, the debit card payin will be also credited in your account. For more information, see Payin Status Flow - Card or check the payin status of a payment.

Example: Debit Card payin response

Status OK

{
    "transactionType": "PayIn",
    "externalId": "TEST10",
    "internalId": "70cf6fdb-f733-4966-9358-5fa456972a6e",
    "paymentMethod": {
        "type": "DebitCard",
        "code": "1005",
        "flow": "DIRECT"
    },
    "country": "ARG",
    "currency": "USD",
    "amount": 100.0,
    "accountNumber": "032.840.00000001",
    "confirmed": {
        "currency": "USD",
        "amount": 100.0,
        "fxQuote": 1.0,
        "exchangeRateToken": null
    },
    "payment": {
        "installment": null,
        "currency": "ARS",
        "fxQuote": 212.4939,
        "financingFee": 0.0,
        "amount": 11952.56
    },
    "localTaxes": [],
    "withHoldings": [],
    "fees": {
        "description": "Fee",
        "currency": "USD",
        "fxSource": 1.0,
        "fxQuote": 1.0,
        "amount": 2.0,
        "account": "032.840.00000001"
    },
    "status": {
        "code": "103",
        "description": "APPROVED",
        "detail": "The payin was confirmed but not credited yet"
    },
    "ticket": null,
    "qr": null,
    "beneficiary": null,
    "merchant": {
        "type": "INDIVIDUAL",
        "name": "Merchant's name",
        "lastname": "Payer's last name",
        "document": {
            "id": "123456",
            "type": "PASS"
        },
        "email": "[e-mail]",
        "phone": {
            "countryCode": "54",
            "areaCode": "11",
            "number": "98789632"
        },
        "address": {
            "street": "Street",
            "number": "938",
            "city": "city",
            "state": "state",
            "country": "country",
            "zipCode": "zipCode",
            "comment": "Add any usefull information"
        },
        "birthdate": "2000-01-01",
        "nationality": "nationality"
    },
    "payer": {
        "type": "COMPANY",
        "name": "Payer's name",
        "lastname": "",
        "document": {
            "id": "28789658",
            "type": "DNI"
        },
        "email": "[e-mail]",
        "phone": {
            "countryCode": "1",
            "areaCode": "11",
            "number": "98789632"
        },
        "address": {
            "street": "Street",
            "number": "1234",
            "city": "city",
            "state": "state",
            "country": "country",
            "zipCode": "zipCode",
            "comment": "Add any relevant information related to the payer"
        },
        "birthdate": "01/01/1990",
        "nationality": "nationality"
    },
    "intermediaries": [],
    "wireInstructions": null,
    "date": {
        "creationDate": "2022-05-19T20:40:45.929+00:00",
        "processedDate": "2022-05-19T20:40:46.742458",
        "expirationDate": "0001-01-01T00:00:00"
    },
    "card": {
        "token": "9ChmD+w4OQJaBaxMl0QHd06KHyJ7/d5wS+atAksS3TM=",
        "bin": "451766",
        "brand": "VISA",
        "country": "AR",
        "name": "Card holder name",
        "last4": "2542",
        "expirationYear": 2025,
        "expirationMonth": 11
    },
    "errors": []
}

Bad request

{
    "transactionType": null,
    "externalId": null,
    "internalId": null,
    "paymentMethod": null,
    "country": null,
    "currency": null,
    "amount": null,
    "accountNumber": null,
    "confirmed": null,
    "payment": null,
    "localTaxes": null,
    "withHoldings": null,
    "fees": null,
    "status": null,
    "ticket": null,
    "qr": null,
    "beneficiary": null,
    "merchant": null,
    "payer": null,
    "intermediaries": null,
    "wireInstructions": null,
    "date": null,
    "card": null,
    "errors": [
        {
            "code": "809",
            "description": "Rejected",
            "detail": "Invalid card number length"
        },
        {
            "code": "801",
            "description": "Rejected",
            "detail": "Params error card "
        },
        {
            "code": "801",
            "description": "Rejected",
            "detail": "Params error  card number, invalid format "
        }
    ]
}

Check the Payin Status Codes

Payin