Create Payin

post

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

This endpoint initiates a Payin transaction, allowing you to collect payments from customers using various payment methods. You can specify details such as the payment method, amount, currency, and customer information. The response will include a transaction ID and status, which can be used to track the payment.

💡
Want to lock an exchange rate before executing the transaction?
Use the Currency Exchange Quote API to generate a rate quote for the currency pair. The response includes an exchangeRateToken pass it in your payin request to lock in that rate. The quoted rate is guaranteed until the token's expirationDate, protecting both you and your user from market fluctuations.

Body Params

paymentMethod

object

required

Payment method details.

externalId

string

required

A unique identifier generated by your system to track the transaction (alphanumeric and hyphens). We recommend using UUID4 to ensure uniqueness.

country

string

required

Country. ISO 3166-1 alpha-3.

currency

string

enum

required

Currency codes. The currency of the amount can be the local currency (charged directly) or the account's currency (triggering a Foreign Exchange operation), with paymentMethod.code resolving ambiguity in bimonetary countries.

amount

number

required

Transaction amount.

accountNumber

string

required

The LocalPayment account number where the specified amount will be credited.

conceptCode

string

required

Concept code.

comment

string

Additional information to identify the transaction on your side.

merchant

object

required

Information about the merchant initiating the transaction.

payer

object

required

Information about the payer making the transaction.

intermediaries

array of objects

Additional information from other parties involved in the payment process.

intermediaries

metaData

object

Contains additional information about the transaction.

transactionType

const

enum

Transaction type.

Allowed:

clientCode

string

Client code.

userReference

string

Your client's username. For example, email or username on your platform.

commercialData

object

required

Contains commercial details about the transaction.

requireAuth

boolean

Indicates whether the transaction requires authentication.

file

boolean

Indicates whether the transaction involves a file upload.

exchangeRateToken

string

Token provided by the Foreign Exchange service in order to use an upfront agreed exchange rate.

device

object

Contains information about the device used to initiate the transaction.

card

object

required

Required for credit and debit card payment methods.

redirectUrl

object

Define URLs for authentication scenarios using 3DS.

Headers

x-capture

boolean

Send true to generate an authorization.

Responses

200OK

400Bad Request.

401Unauthorized.