Retrieve a payment link

GET

/gateway/payment-links/{id}

• Shared development environment (test money only)

Required scope: payments:read.

Authorizations

• apiKeyAuth

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

Success

object

allowed_cryptos

Array<string>

created_at

required

string

description

string

nullable

id

required

string format: uuid

is_active

required

boolean

last_payment_at

string

nullable

link_payments

integer

link_views

integer

merchant_id

required

string format: uuid

name

required

string

note_for_customer

string

nullable

preset_amount_ghs

Legacy display value. Use its exact decimal-string counterpart for financial decisions.

number

nullable

preset_crypto_type

string

nullable

slug

string

nullable

statistics_scope

string

total_amount_received

Legacy display value. Use its exact decimal-string counterpart for financial decisions.

number

nullable

updated_at

string

400

Validation error

R15 canonical error envelope. Every 4xx/5xx JSON body carries these five keys, plus x-request-id header; 4xx machine fields (e.g. available_balance) merge in alongside and never shadow them.

object

error

required

Machine code (SCREAMING_SNAKE)

string

Example

VALIDATION_ERROR

message

required

Human-readable detail

string

Example

amount_ghs must be greater than zero

request_id

required

Mirrors the x-request-id response header

string format: uuid

retriable

required

True for 429/502/503/504 only; 400/401/403/404/409 are final

boolean

timestamp

required

string format: date-time

401

Invalid key

R15 canonical error envelope. Every 4xx/5xx JSON body carries these five keys, plus x-request-id header; 4xx machine fields (e.g. available_balance) merge in alongside and never shadow them.

object

error

required

Machine code (SCREAMING_SNAKE)

string

Example

VALIDATION_ERROR

message

required

Human-readable detail

string

Example

amount_ghs must be greater than zero

request_id

required

Mirrors the x-request-id response header

string format: uuid

retriable

required

True for 429/502/503/504 only; 400/401/403/404/409 are final

boolean

timestamp

required

string format: date-time

403

Scope, merchant or environment denied

R15 canonical error envelope. Every 4xx/5xx JSON body carries these five keys, plus x-request-id header; 4xx machine fields (e.g. available_balance) merge in alongside and never shadow them.

object

error

required

Machine code (SCREAMING_SNAKE)

string

Example

VALIDATION_ERROR

message

required

Human-readable detail

string

Example

amount_ghs must be greater than zero

request_id

required

Mirrors the x-request-id response header

string format: uuid

retriable

required

True for 429/502/503/504 only; 400/401/403/404/409 are final

boolean

timestamp

required

string format: date-time

404

Not found

R15 canonical error envelope. Every 4xx/5xx JSON body carries these five keys, plus x-request-id header; 4xx machine fields (e.g. available_balance) merge in alongside and never shadow them.

object

error

required

Machine code (SCREAMING_SNAKE)

string

Example

VALIDATION_ERROR

message

required

Human-readable detail

string

Example

amount_ghs must be greater than zero

request_id

required

Mirrors the x-request-id response header

string format: uuid

retriable

required

True for 429/502/503/504 only; 400/401/403/404/409 are final

boolean

timestamp

required

string format: date-time

409

Intent conflict

R15 canonical error envelope. Every 4xx/5xx JSON body carries these five keys, plus x-request-id header; 4xx machine fields (e.g. available_balance) merge in alongside and never shadow them.

object

error

required

Machine code (SCREAMING_SNAKE)

string

Example

VALIDATION_ERROR

message

required

Human-readable detail

string

Example

amount_ghs must be greater than zero

request_id

required

Mirrors the x-request-id response header

string format: uuid

retriable

required

True for 429/502/503/504 only; 400/401/403/404/409 are final

boolean

timestamp

required

string format: date-time

429

Rate limited

R15 canonical error envelope. Every 4xx/5xx JSON body carries these five keys, plus x-request-id header; 4xx machine fields (e.g. available_balance) merge in alongside and never shadow them.

object

error

required

Machine code (SCREAMING_SNAKE)

string

Example

VALIDATION_ERROR

message

required

Human-readable detail

string

Example

amount_ghs must be greater than zero

request_id

required

Mirrors the x-request-id response header

string format: uuid

retriable

required

True for 429/502/503/504 only; 400/401/403/404/409 are final

boolean

timestamp

required

string format: date-time

500

Internal error

R15 canonical error envelope. Every 4xx/5xx JSON body carries these five keys, plus x-request-id header; 4xx machine fields (e.g. available_balance) merge in alongside and never shadow them.

object

error

required

Machine code (SCREAMING_SNAKE)

string

Example

VALIDATION_ERROR

message

required

Human-readable detail

string

Example

amount_ghs must be greater than zero

request_id

required

Mirrors the x-request-id response header

string format: uuid

retriable

required

True for 429/502/503/504 only; 400/401/403/404/409 are final

boolean

timestamp

required

string format: date-time

503

Service unavailable

R15 canonical error envelope. Every 4xx/5xx JSON body carries these five keys, plus x-request-id header; 4xx machine fields (e.g. available_balance) merge in alongside and never shadow them.

object

error

required

Machine code (SCREAMING_SNAKE)

string

Example

VALIDATION_ERROR

message

required

Human-readable detail

string

Example

amount_ghs must be greater than zero

request_id

required

Mirrors the x-request-id response header

string format: uuid

retriable

required

True for 429/502/503/504 only; 400/401/403/404/409 are final

boolean

timestamp

required

string format: date-time