Skip to main content
POST
payments.payment-link.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json

paymentLinkId in your connected merchant account. Send this or ref, not both.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
ref
string

The ref returned by payments.payment-link.create.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$

Response

The result

Payment link id in your connected merchant account; the ref you sent when the request used ref.

status
enum<string>
required

Current payment link state.

Available options:
created,
partially_paid,
paid,
expired,
canceled,
unknown
amount
object

Amount requested in minor units; absent when the customer chooses the amount.

minimumAmount
object

Smallest amount a customer may choose, in minor units, when they choose.

amountPaid
object

Amount already collected.

reusable
boolean

Whether several customers can pay through the link.

archived
boolean

Whether the link is archived.

paidAt
string

When the link was paid, ISO 8601.

paymentUrl
string

Temporary platform link that opens the payment page; obtain a fresh link when it expires.

When the temporary platform link expires, ISO 8601.

expiresAt
string

When the payment request expires, ISO 8601.

reference
string

Your own reference.

description
string

What the payment is for.

allowPartial
boolean

Whether partial payments are accepted.

notes
object

Your own reference notes, at most 15 entries of 256 characters each.

createdAt
string

When the payment link was created, ISO 8601.

payments
object[]

Captured payments, only when the request used ref; at most 50. An incomplete or larger snapshot is refused.

Maximum array length: 50