Create payin link
Use link type general
if you want Palomma to collect payment method details.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
Amount to be paid in COP. Must be greater than $1500. The maxiumum is configured per merchant but defaults to $2.000.000. Contact us if you need to increase this limit.
The payment methods types that are available for the customer to select.
pse
, bancolombiaButton
, nequiButton
, card
, bancolombiaCollect
The ID of the customer for whom the Payin Link is created.
URL to which the customer will be redirected after the payment process.
general
An optional description of the Payin Link.
Datetime when link will expire in YYYY-MM-DDTHH:mm:ss format. By default, expiration is at the end of the day after the link creation. Minimum expiration is the current date and maximum expiration is at the end of the 7th day from creation. Links expire shortly after the specified datetime has passed.
An optional reference provided by the merchant to identify the Payin Link.
An optional account ID of the target merchant account for this Payin Link.
Response
The total amount to be paid in COP.
The amount that has been collected in COP.
ISO string representing when the Payin Link was created.
The ID of the customer for whom the Payin Link is created.
Description of the Payin Link.
Datetime when link will expire in YYYY-MM-DDTHH:mm:ss format. By default, expiration is at the end of the day after the link creation. Minimum expiration is the current date and maximum expiration is at the end of the 7th day from creation. Links expire shortly after the specified datetime has passed.
Any fee associated with the Payin Link.
Unique identifier for the Payin Link.
URL to which the customer can go to complete the payment.
URL to which the customer will be redirected after the payment process.
An optional reference provided by the merchant to identify the Payin Link.
The current status of the Payin Link.
pending
, processing
, approved
, cancelled
Additional detail on the status. Only present when status is "cancelled".
AUTHENTICATION_FAILED
, CUSTOMER_CANCELLATION
, DECLINED_BY_BANK
, EXPIRED
, INVALID_ACCOUNT
, NOT_ENOUGH_FUNDS
, ERROR
Account ID of the target merchant account for this Payin Link.
The type of Payin Link
general
, pse
, bancolombiaButton
, nequiButton
, card
, bancolombiaCollect
ISO string representing when the Payin Link was last updated.