Skip to main content

Store Travel Address

POST 
https://api.ping.exchange/frontoffice/api/v1/travel/data

Collecting travel information and saving it in PingExchange, if given signature is valid.

  • the supplier needs to initially submit their information in the PingExchange.
  • To transmit and save information in the PingExchange, it is essential to invoke this API.

Request​

Header Parameters

    X-Signature stringrequired

    Before calling this API, the originatorBeneficiary object should be converted into a JSON object (not indented, camelCase) and then encrypted using the HMAC SHA256 encryption algorithm with the shared key.

    • The resulting hash value is included as x-signature in the request header.
    • Please be aware that currently, we exclusively offer support for HMAC256.
    • Generated hash value should be in Hex format.

Body

required

StoreAddress request.

  • The body object of this method comprises two primary sections:

  • originatorBeneficiary and vaspId.

    originatorBeneficiary

    object

    required

    originator

    object

    customerId stringrequired

    Possible values: <= 255 characters, Value must match regular expression ^[a-zA-Z0-9-.\s]*$

    Represents the customer ID.

    name stringrequired

    Possible values: <= 255 characters, Value must match regular expression ^([\p{L}\p{N}\s-/])*$

    Represents the name of the originator.

    physicalAddress stringrequired

    Possible values: <= 255 characters, Value must match regular expression ^[a-zA-Z0-9-,.\s]*$

    Represents the physical address of the originator.

    walletAddress stringrequired

    Possible values: <= 255 characters, Value must match regular expression ^[a-zA-Z0-9-.\s]*$

    Represents the wallet address of the originator.

    documentNumber stringrequired

    Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z0-9-.\s]*$

    Represents the document number of the originator.

    dateOfBirth date-timerequired

    Represents the date of birth of the originator.

    placeOfBirth stringrequired

    Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z0-9-.\s]*$

    Represents the place of birth of the originator.

    beneficiary

    object

    customerId stringnullable

    Possible values: <= 255 characters, Value must match regular expression ^[a-zA-Z0-9-.\s]*$

    Represents the customer ID of the beneficiary.

    name stringrequired

    Possible values: <= 255 characters, Value must match regular expression ^[a-zA-Z0-9-.\s]*$

    Represents the name of the beneficiary.

    walletAddress stringrequired

    Possible values: <= 255 characters, Value must match regular expression ^[a-zA-Z0-9-.\s]*$

    Represents the wallet address of the beneficiary.

    originatorVASP stringrequired

    Possible values: <= 255 characters, Value must match regular expression ^[a-zA-Z0-9-.\s]*$

    The VASP ID of the originator.

    assetId stringrequired

    Possible values: <= 12 characters, Value must match regular expression ^[a-zA-Z]{3,12}$

    The asset ID.

    transactionId stringrequired

    Possible values: <= 128 characters, Value must match regular expression ^[a-zA-Z0-9-.\s]*$

    The transaction ID.

    amount doublerequired

    The amount associated with the transaction.

    vaspId stringrequired

    Possible values: <= 255 characters, Value must match regular expression ^[a-zA-Z0-9-.\s]*$

    The Virtual Asset Provider ID.

Responses​

No Content

curl -L -X POST 'https://api.ping.exchange/frontoffice/api/v1/travel/data' \
-H 'Content-Type: application/json-patch+json' \
--data-raw '{
  "originatorBeneficiary": {
    "originator": {
      "customerId": "7f8c5d2a-6d4e-4f3b-bf7a-9a0e8c1cd2a9",
      "name": "John Doe",
      "physicalAddress": "123 Maple Street, Greenfield, CA 98765",
      "walletAddress": "0x1aBcD23Ef4567aBCdeF890123456789aBCdEf012",
      "documentNumber": "7644221063",
      "dateOfBirth": "2000/01/01",
      "placeOfBirth": "string"
    },
    "beneficiary": {
      "customerId": "7f8c5d2a-6d4e-4f3b-bf7a-9a0e8c1cd2a9",
      "name": "Jane Doe",
      "walletAddress": "0x9876543210ABCDEF0123456789abcdefABCDEF01"
    },
    "originatorVASP": "string",
    "assetId": "xcb",
    "transactionId": "0x3f5ce5fbfe3e9af3971dd833d26ba9b5c936f0be2ff1a2b1e37a8d6ae7e8a6c4",
    "amount": 1.05
  },
  "vaspId": "Ping"
}'
Request Collapse all
Base URL
https://api.ping.exchange
Parameters
— headerrequired
Body required
{
  "originatorBeneficiary": {
    "originator": {
      "customerId": "7f8c5d2a-6d4e-4f3b-bf7a-9a0e8c1cd2a9",
      "name": "John Doe",
      "physicalAddress": "123 Maple Street, Greenfield, CA 98765",
      "walletAddress": "0x1aBcD23Ef4567aBCdeF890123456789aBCdEf012",
      "documentNumber": "7644221063",
      "dateOfBirth": "2000/01/01",
      "placeOfBirth": "string"
    },
    "beneficiary": {
      "customerId": "7f8c5d2a-6d4e-4f3b-bf7a-9a0e8c1cd2a9",
      "name": "Jane Doe",
      "walletAddress": "0x9876543210ABCDEF0123456789abcdefABCDEF01"
    },
    "originatorVASP": "string",
    "assetId": "xcb",
    "transactionId": "0x3f5ce5fbfe3e9af3971dd833d26ba9b5c936f0be2ff1a2b1e37a8d6ae7e8a6c4",
    "amount": 1.05
  },
  "vaspId": "Ping"
}
ResponseClear

Click the Send API Request button above and see the response here!