Payment Links

Authentication: endpoints listed in this page require header authentication with a service token with the payment-links:admin scope.

List payment links

GET https://payment-links.powens.com/api/payment-links

Headers

Name	Type	Description
Authorization*	String	Bearer Authorization header.

200: OK List of payments

Response body: array of PaymentLink object

Create a payment link

POST https://payment-links.powens.com/api/payment-links

Request body: PaymentLinkRequest object

Headers

Name	Type	Description
Authorization*	String	Bearer Authorization header.

200: OK Created payment link

Response body: PaymentLink object

Retrieve a payment link

GET https://payment-links.powens.com/api/payment-links/{id}

Headers

Name	Type	Description
Authorization*	String	Bearer Authorization header.

200: OK Payment link

Response body: PaymentLink object

404: Not Found No such payment link

Revoke a payment link

POST https://payment-links.powens.com/api/payment-links/{id}:revoke

Headers

Name	Type	Description
Authorization*	String	Bearer Authorization header.

204: No Content Payment link revoked

404: Not Found No such payment link or already revoked

Request payloads

PaymentLinkRequest object

Property	Type	Presence	Description
reference_id	String	Optional	The end-to-end identifier to provide the underlying payment with.
amount	Number	Required	The amount of the currency to provide when creating the payment.
currency	String	Required	The currency code of the payment amount, a per ISO 4217.
label	String	Required	The unstructured remittance information to provide the created payment.
execution_date _type	String	Required	Either "first_open_day" or "instant".
beneficiary	PaymentAccount object	Required	The beneficiary for the payment link.
beneficiary _identity	Identity object	Required	The beneficiary's identity.
payer	PaymentAccount object or null	Required	The payer for the payment link, if available.
payer_identity	Identity object	Required	The payer's identity.
operator _identity	Identity object	Optional	The operator's identity.
redirect	Boolean	Required	Whether to redirect at the end of the flow or not.
redirect_uri	String or null	Conditional	The URL to redirect the end user to at the end of the payment link validation. Must be provided if redirect was set to true.
redirect_state	String or null	Conditional	The optional state with which to redirect the end user at the end of the payment link validation. Must be provided if redirect was set to true.

Resources

PaymentLink object

Property	Type	Description
id	String	The UUID of the created payment link.
reference_id	String	The end-to-end identifier to provide the underlying payment with.
amount	Number	The amount of the currency to provide when creating the payment.
currency	String	The currency code of the payment amount, a per ISO 4217.
label	String	The unstructured remittance information to provide the created payment.
execution_date _type	String	Either "first_open_day" or "instant", as defined in ExecutionDate values.
beneficiary	PaymentAccount object	The beneficiary for the payment link.
beneficiary _identity	Identity object	The beneficiary's identity.
payer	PaymentAccount object or null	The payer for the payment link, if available.
payer_identity	Identity object	The payer's identity.
operator _identity	Identity object	The operator's identity.
redirect	Boolean	Whether to redirect at the end of the flow.
redirect_uri	String	The URL to redirect the end user to at the end of the payment link validation. If redirect is set to false, this property may be set to an empty string.
redirect_state	String	The optional state with which to redirect the end user at the end of the payment link validation. If redirect is set to false, this property may be set to an empty string.
last_payment_id	Integer or null	The identifier of the created payment on the domain.
url	String	The URL for the payment link, to transmit to the end user.
revoked_at	Datetime or null	The date and time at which the payment link has been or should be revoked, if relevant.
attempt_state	PaymentState value, "unavailable" or null	State of the latest payment attempt. May be set to "unavailable" if either no payment has been created yet (payment_id is null), or the Payments API is currently unavailable.