API
Checking Raims account

Retrieve a payment link

Check the URL, configuration and whether the charge can still be paid through the link.

GEThttps://api.raims.com/v1/payment_links/{id}

Looks up a link by the identifier received when creating or listing links. The link must belong to the company and environment of your API key.

The charge_id field identifies the linked charge. Use this identifier in Retrieve a charge to check the customer, amount, due date, status and available payment data.

is_active indicates whether the link is active or paused. An active link still depends on the charge's conditions to accept payment. is_payable indicates whether the charge can still be paid through this link. A charge that has already been paid, revoked or expired, for example, does not allow another payment through the link. If the value is false, check unavailable_reason.code to understand why. When the reason is a pause, the code is PAYMENT_LINK_PAUSED. The link remains available for lookup and uses the same URL after reactivation.

See how to use the returned address in Payment links. The lookup does not create or change the charge or issue payment data.

Path Params

Public link identifier received when creating or listing links.

Up to 100 characters

Responses

For common errors, see HTTP response codes.