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'.

​
id
string
required

Unique identifier of the payment link.

​
url
string
required

URL of the payment link.

​
status
enum<string>
required

Current status of the payment link.

Available options:
ACTIVATED,
DEACTIVATED,
PENDING
​
maxAmount
string
required

The max amount to be signed by the buyer.

​
token
string
required

The token address used for the payment.

​
networkId
integer<int32>
required

Blockchain network identifier.

​
operator
string
required

Operator handling the payment link.

​
receiver
string
required

The receiver's address.

​
minFeeBps
integer<int32>
required

Min Fee in basis points.

​
maxFeeBps
integer<int32>
required

Max Fee in basis points.

​
feeReceiver
string
required

Address that receives the fee.

​
maxUsage
integer<int32>
required

Maximum number of uses.

​
usageCount
integer<int32>
required

Current usage count.

​
successRedirectUrl
string
required

URL to redirect after successful payment.

​
failRedirectUrl
string
required

URL to redirect after failed payment.

​
createdAt
string<date-time>
required

Timestamp when the payment link was created.

​
updatedAt
string<date-time>
required

Timestamp when the payment link was last updated.

​
contractAddress
string
required

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

​
salt
string
required

Source of entropy to ensure unique hashes across different payments.

​
nonce
string
required

Unique nonce for the payment link preapproval authorization.

​
merchant
Merchant · object
required

Merchant information.

​
customer
Customer · object
required

Customer information.

​
fiat
Fiat · object
required

Fiat details.

​
hostUrl
string
required

Host URL for the payment link.

​
preApprovalExpiry
string<int64>

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

​
authorizationExpiry
string<int64>

Timestamp (in seconds) when the authorization expires.

​
refundExpiry
string<int64>

Timestamp (in seconds) when the refund expires.