Create deposit Travel Rule link

Issue a redirect link to the Deposit Travel Rule embedded page. The end user opens redirectUrl and completes the Travel Rule declaration for a deposit there.

Behaviour

No request body. The caller's identity is resolved from the OpenAPI authentication headers, so nothing else has to be sent.

redirectUrl has the form {host}/en/deposit-travel-rule?token={token}. The path is fixed and English is currently the only language served by that page. {host} is environment-specific — https://merchant.bpn.finance in production, https://sandbox.bpn.finance in sandbox.

The token is scoped to the authenticated merchant and authenticates the embedded page session. Every call issues a new token, and the token is short-lived (60 minutes by default), so redirect the end user promptly rather than storing the link.

Error codes

HTTP	`code`	Condition
400	`10000046`	The caller's identity could not be resolved from the authentication headers.

API Key

Add parameter in header

API-KEY

Example:

API-KEY: ********************

API Key

Add parameter in header

API-SIGNATURE

Example:

API-SIGNATURE: ********************

API Key

Add parameter in header

API-TIMESTAMP

Example:

API-TIMESTAMP: ********************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Bodyapplication/json

Example

{
    "status": 200,
    "code": "SUCCESS",
    "msg": "ok",
    "data": {
        "redirectUrl": "https://merchant.bpn.finance/en/deposit-travel-rule?token=7f3a91c2e84b4d6fa0c5e1b93d27a8f4"
    },
    "traceId": "a1b2c3d4e5f6"
}

Create deposit Travel Rule link

Behaviour#

Error codes#

Request

Request Code Samples

Responses

Behaviour

Error codes