Skip to main content
GET
/
api
/
v1
/
payment-links
/
{id}
Get payment link
curl --request GET \
  --url https://payments.coinbase.com/api/v1/payment-links/{id}
{
  "entity": "<string>",
  "id": "<string>",
  "url": "<string>",
  "status": "ACTIVATED",
  "maxAmount": "<string>",
  "token": "<string>",
  "networkId": 123,
  "operator": "<string>",
  "receiver": "<string>",
  "minFeeBps": 123,
  "maxFeeBps": 123,
  "feeReceiver": "<string>",
  "maxUsage": 123,
  "usageCount": 123,
  "successRedirectUrl": "<string>",
  "failRedirectUrl": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "contractAddress": "<string>",
  "salt": "<string>",
  "nonce": "<string>",
  "merchant": {
    "name": "<string>",
    "logoUrl": "<string>",
    "locale": "<string>",
    "metadata": {}
  },
  "customer": {
    "locale": "<string>",
    "metadata": {}
  },
  "fiat": {
    "amount": "<string>",
    "currency": "<string>",
    "metadata": {}
  },
  "hostUrl": "<string>",
  "preApprovalExpiry": "<string>",
  "authorizationExpiry": "<string>",
  "refundExpiry": "<string>"
}

Path Parameters

​
id
string
required

Unique identifier of the payment link to retrieve.

Response

A successful response.

Representation of a payment link including its URL, status, and related merchant, customer, and fiat information.

​
entity
string
required

Entity type, usually 'paymentLink'.

Example:

"paymentLink"

​
id
string
required

Unique identifier of the payment link.

Example:

"link123"

​
url
string
required

URL of the payment link.

Example:

"https://pay.example.com/link123"

​
status
enum<string>
required

Current status of the payment link.

Available options:
ACTIVATED,
DEACTIVATED,
PENDING
Example:

"ACTIVATED"

​
maxAmount
string
required

The max amount to be signed by the buyer.

Example:

"100.00"

​
token
string
required

The token address used for the payment.

Example:

"0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"

​
networkId
integer<int32>
required

Blockchain network identifier.

Example:

"8453"

​
operator
string
required

Operator handling the payment link.

Example:

"0xoperator"

​
receiver
string
required

The receiver's address.

Example:

"0xreceiver"

​
minFeeBps
integer<int32>
required

Min Fee in basis points.

Example:

"50"

​
maxFeeBps
integer<int32>
required

Max Fee in basis points.

Example:

"50"

​
feeReceiver
string
required

Address that receives the fee.

Example:

"0xfee789"

​
maxUsage
integer<int32>
required

Maximum number of uses.

Example:

"100"

​
usageCount
integer<int32>
required

Current usage count.

Example:

"10"

​
successRedirectUrl
string
required

URL to redirect after successful payment.

Example:

"https://example.com/success"

​
failRedirectUrl
string
required

URL to redirect after failed payment.

Example:

"https://example.com/fail"

​
createdAt
string<date-time>
required

Timestamp when the payment link was created.

Example:

"2024-03-20T00:00:00.000Z"

​
updatedAt
string<date-time>
required

Timestamp when the payment link was last updated.

Example:

"2024-03-20T00:00:00.000Z"

​
contractAddress
string
required

Smart contract address of the Commerce PaymentEscrow protocolof the Commerce PaymentEscrow protocol.

Example:

"0xBdEA0D1bcC5966192B070Fdf62aB4EF5b4420cff"

​
salt
string
required

Source of entropy to ensure unique hashes across different payments.

Example:

"2334324235415445346745646"

​
nonce
string
required

Unique nonce for the payment link preapproval authorization.

Example:

"2334324235415445346745646"

​
merchant
Merchant · object
required

Merchant information.

Example:
{
  "name": "MerchantName",
  "logoUrl": "https://example.com/logo.png",
  "locale": "en-US",
  "metadata": "{}"
}
​
customer
Customer · object
required

Customer information.

Example:
{ "locale": "en-US", "metadata": "{}" }
​
fiat
Fiat · object
required

Fiat details.

Example:
{
  "amount": "10.00",
  "currency": "USD",
  "metadata": "{}"
}
​
hostUrl
string
required

Host URL for the payment link.

Example:

"https://example.com"

​
preApprovalExpiry
string<int64>

Timestamp (in seconds) when the pre-approval expires.

Example:

"0"

​
authorizationExpiry
string<int64>

Timestamp (in seconds) when the authorization expires.

Example:

"1843954582"

​
refundExpiry
string<int64>

Timestamp (in seconds) when the refund expires.

Example:

"1843954582"