Skip to main content
GET
/
finops
/
v1
/
payment-links
/
{payment_link_id}
Get payment link by ID
curl --request GET \
  --url https://api.sandbox.tesouro.com/finops/v1/payment-links/{payment_link_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-finops-version: <x-finops-version>' \
  --header 'x-organization-id: <x-organization-id>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 123,
  "currency": "AED",
  "expires_at": "2023-11-07T05:31:56Z",
  "payment_intent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payment_methods": [
    "<string>"
  ],
  "payment_page_url": "<string>",
  "recipient": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "entity",
    "bank_accounts": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "account_holder_name": "<string>",
        "account_number": "<string>",
        "bic": "<string>",
        "country": "US",
        "currency": "USD",
        "display_name": "<string>",
        "iban": "<string>",
        "is_default": false,
        "name": "<string>",
        "routing_number": "<string>",
        "sort_code": "<string>",
        "was_created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "name": "<string>"
  },
  "status": "<string>",
  "invoice": {
    "due_date": "2023-12-25",
    "file": {
      "mimetype": "<string>",
      "name": "<string>",
      "url": "<string>"
    },
    "issue_date": "2023-12-25"
  },
  "payer": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "entity",
    "bank_accounts": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "account_holder_name": "<string>",
        "account_number": "<string>",
        "bic": "<string>",
        "country": "US",
        "currency": "USD",
        "display_name": "<string>",
        "iban": "<string>",
        "is_default": false,
        "name": "<string>",
        "routing_number": "<string>",
        "sort_code": "<string>",
        "was_created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "name": "<string>"
  },
  "payment_intent": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "updated_at": "2023-11-07T05:31:56Z",
    "status": "<string>",
    "application_fee_amount": 123,
    "object": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "payable"
    },
    "provider": "<string>",
    "selected_payment_method": "<string>"
  },
  "payment_reference": "<string>",
  "return_url": "https://pay.example.com/complete"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-finops-version
string<date>
required
​
x-organization-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Path Parameters

​
payment_link_id
string<uuid>
required

Response

Successful Response

​
id
string<uuid>
required
​
amount
integer
required
​
currency
enum<string>
required
Available options:
AED,
AFN,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BTN,
BWP,
BYN,
BZD,
CAD,
CDF,
CHF,
CLP,
CNY,
COP,
CRC,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SEK,
SGD,
SHP,
SLE,
SOS,
SRD,
SSP,
SVC,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VND,
VUV,
WST,
XAF,
XCD,
XOF,
XPF,
YER,
ZAR,
ZMW
​
expires_at
string<date-time>
required
​
payment_intent_id
string<uuid>
required
​
payment_methods
string[]
required
​
payment_page_url
string<uri>
required
Required string length: 1 - 2083
​
recipient
object
required
​
status
string
required
​
invoice
object
​
payer
object
​
payment_intent
object
​
payment_reference
string
​
return_url
string

The URL where to redirect the payer after the payment. If return_url is specified, then after the payment is completed the payment page will display the "Return to platform" link that navigates to this URL.

Example:

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