Introduction
API Documentation
- General
- Receiving Money
- Sending Money
- Endpoints
- Customers
- Payin Links
- Payin Sources
- Payin Requests
- Payout Targets
- Payout Requests
- Merchant Accounts
- Status Messages
Webhooks
Payin Links
Retrieve payin link
GET
/
payinLinks
/
{payinLinkId}
curl --request GET \
--url https://prod.api.palomma.com/v0/payinLinks/{payinLinkId} \
--header 'Authorization: Bearer <token>'
{
"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"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Unique identifier of the payin link.
Response
200
application/json
Payin Link retrieved successfully.
The response is of type object
.
curl --request GET \
--url https://prod.api.palomma.com/v0/payinLinks/{payinLinkId} \
--header 'Authorization: Bearer <token>'
{
"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"
}
Assistant
Responses are generated using AI and may contain mistakes.