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
header
required

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

Body

application/json

Response

200
application/json

Payin Link created successfully

The response is of type object.