POST
/
payinLinks
curl --request POST \
  --url https://prod.api.palomma.com/v0/payinLinks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "reference": "<string>",
  "description": "<string>",
  "customerId": "<string>",
  "redirectUrl": "<string>",
  "amount": 123,
  "type": "general",
  "availableTypes": [
    "pse"
  ],
  "expiration": "<string>",
  "targetMerchantAccountId": "<string>"
}'
{
  "id": "01HPR5TEDFKT498V8CYY3RPCXP",
  "reference": "<string>",
  "description": "<string>",
  "customerId": "01HPR57X6QR5ZRKEEKBSDBW4RA",
  "customerDetails": {
    "reference": "<string>",
    "name": "Pepito Perez",
    "documentType": "cc",
    "documentNumber": "1037551022",
    "email": "pepito@gmail.com",
    "phoneNumber": "3013111111"
  },
  "status": "approved",
  "statusMessage": "AUTHENTICATION_FAILED",
  "paymentUrl": "http://payments.palomma.com/payinLinks?payinLinkId=01HPR5TEDFKT498V8CYY3RPCXP",
  "redirectUrl": "http://merchant.com/checkout",
  "amount": 100000,
  "amountCollected": 100000,
  "fee": 500,
  "type": "general",
  "expiration": "<string>",
  "targetMerchantAccountId": "default",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Use link type general if you want Palomma to collect payment method details.

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
reference
string

An optional reference provided by the merchant to identify the Payin Link.

description
string

An optional description of the Payin Link.

customerId
string
required

The ID of the customer for whom the Payin Link is created.

redirectUrl
string
required

URL to which the customer will be redirected after the payment process.

amount
number
required

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.

type
enum<string>
required
Available options:
general
availableTypes
enum<string>[]
required

The payment methods types that are available for the customer to select.

Available options:
pse,
bancolombiaButton,
nequiButton,
card,
bancolombiaCollect
expiration
string

Date when link will expire in YYYY-MM-DD format. By default, expiration is on the day after the link creation. Minimum expiration is the current date and maximum expiration is 7 days from creation. Links expire shortly after the day on the expiration date ends.

targetMerchantAccountId
string

An optional account ID of the target merchant account for this Payin Link.

Response

200 - application/json
id
string

Unique identifier for the Payin Link.

reference
string

An optional reference provided by the merchant to identify the Payin Link.

description
string

Description of the Payin Link.

customerId
string

The ID of the customer for whom the Payin Link is created.

customerDetails
object
status
enum<string>

The current status of the Payin Link.

Available options:
pending,
processing,
approved,
cancelled
statusMessage
enum<string>

Additional detail on the status. Only present when status is "cancelled".

Available options:
AUTHENTICATION_FAILED,
CUSTOMER_CANCELLATION,
DECLINED_BY_BANK,
EXPIRED,
INVALID_ACCOUNT,
NOT_ENOUGH_FUNDS,
ERROR
paymentUrl
string

URL to which the customer can go to complete the payment.

redirectUrl
string

URL to which the customer will be redirected after the payment process.

amount
number

The total amount to be paid in COP.

amountCollected
number

The amount that has been collected in COP.

fee
number

Any fee associated with the Payin Link.

type
enum<string>

The type of Payin Link

Available options:
general,
pse,
bancolombiaButton,
nequiButton,
card,
bancolombiaCollect
expiration
string

Date when link will expire in YYYY-MM-DD format. By default, expiration is on the day after the link creation. Minimum expiration is the current date and maximum expiration is 7 days from creation. Links expire shortly after the day on the expiration date ends.

targetMerchantAccountId
string

Account ID of the target merchant account for this Payin Link.

createdAt
string

ISO string representing when the Payin Link was created.

updatedAt
string

ISO string representing when the Payin Link was last updated.

StatusList all payin links