Capture
Post a credit card payment order: one step
Credit Card Capture
POST
https://api.stage.localpayment.com /api/payin
Create a Credit Card Payin (one step)
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Mandatory. JWT token in format |
Request Body
Name | Type | Description |
---|---|---|
paymentMethod* | OBJECT | Mandatory. Payment method details |
paymentMethod.type* | string | Mandatory. |
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 |
paymentMethod.flow* | string | Mandatory. The payment method data could be embeded in the API request ( |
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: |
name* | string | Mandatory. |
lastName | string | Mandatory for |
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 |
name* | string | Mandatory. |
merchant* | OBJECT | Mandatory. Party Object. |
type* | string | Mandatory. Possible values: |
document.type | string | Optional. Document type (related to the merchant's residence) |
phone.countryCode | string | Optional. |
phone | OBJECT | Optional. Party Object. Contact phone number |
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 |
card.name* | string | Mandatory. Cardholder name, as printed on the front of the debitcard. |
card.expirationMonth* | string | Mandatory. Card expiration month. Format |
card.cvv* | string | Mandatory. Card Verification Value |
card.number* | number | Mandatory. Card number (PAN) |
card.expirationYear* | string | Mandatory. Card expiration year. Format |
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 |
beneficiary | OBJECT | Optional. Party Object. |
name | string | Optional. |
type | string | Optional. Possible values: |
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 beneficiary's residence) |
document | OBJECT | Optional. Party Object. |
card.save | bool |
Please refer to this article to learn more about the document type required for the different payment methods by country.
Examples: Credit Card Payin (one step)
To create a credit card payment order, the request body examples are detailed below.
Examples: Save a Card on a Payment
You can save a card while making a Payment / Authorization. To do so, simply add a "save" : true
parameter in the card
object of the request.