B2B API Specification | North Developer

B2B Payment API

e2ee

End-to-end-encryption (e2ee) helps to ensure that sensitive data remains unreadable in as many locations as possible. Primarily card data (credit and debit) and other sensitive data points fall into this category.

In contrast to earlier API versions, all data points noted as e2ee are required to be encrypted before being sent to this API.

The following endpoints will enable you to accomplish this via code.

Get Public Key

get /v3/e2ee/public-key.pem

Provides the public key side of the asymmetric encryption, needed for the actual endpoints requiring e2ee, as well as the following test endpoint.

Example Response

200 Successful Response

e2ee Test (Confirm Your Key Fetching + Encryption Works)

post /v3/e2ee/test

If you receive a successful/expected response from this endpoint, you should never encounter an encryption/decryption error on the endpoints that require it.

If implementing your own e2ee client, it is advised to make sure your calls pass on this endpoint before calling the "real" ones.

Creating the value manually, using CLI tools:


$DOMAIN='https://api.paytrace.com/v3' # Adjust to sandbox as needed
CIPHERTEXT=$(openssl pkeyutl               -encrypt               -inkey <(curl -s "$DOMAIN"/e2ee/public-key.pem | jq -r .data)             CIPHERTEXT=$(openssl pkeyutl \
  -encrypt \
  -inkey <(curl -s "$DOMAIN"/e2ee/public-key.pem | jq -r .data) \
  -pkeyopt rsa_padding_mode:oaep \
  -pubin -in <(echo -n "$INPUT") | base64 | tr -d'\n')

Testing the value manually, using CLI tools: At this point, you can manually inspect the value (

echo $CIPHERTEXT

), or put it into your HTTP client of choice, or use the Try It Out button as part of this documentation.

If all is well, you should see a True response (if not, you will see an error).

Common errors Ensure you are using the correct padding (RSA-OAEP) and correct encoding (base64, NOT base64 url encoded).

Request Schema

data required

string329 to 359 characters

Example:

htpAmr1TJ2hujwO/ObS8oFG3/AhF3AU0zh4QzgynFJejRxUOoyJ1MTXW54UD6F2cvuDCgLLMjY u1K8ybAX/Ap4HvsthqdMz5lYhDj1GwcDBUnZQx+upD/8gZNUHnm5S4EZkAXMNT79iwLCd++X97yOatd3 jhjxaC0zdRUABYr6PuVEYa7gXTEO3LIiOuA/noLVhrD7ZPni8dnCluyIk2z2k6OwDdCYFwvgpuuZ/luRb oG07uYBm1TfHnrLkuCGOxeP7B8Aa0rY1du7GFwXxYadI21AqrgM+DCJLfX156lil0gL4D/ZMQoTIr1hqDr 9WKv92V3M+H6Gsx7z0iCbn+8Ug==

Example Request

{
  "data": "htpAmr1TJ2hujwO/ObS8oFG3/AhF3AU0zh4QzgynFJejRxUOoyJ1MTXW54UD6F2cvuDCgLLMjY             u1K8ybAX/Ap4HvsthqdMz5lYhDj1GwcDBUnZQx+upD/8gZNUHnm5S4EZkAXMNT79iwLCd++X97yOatd3             jhjxaC0zdRUABYr6PuVEYa7gXTEO3LIiOuA/noLVhrD7ZPni8dnCluyIk2z2k6OwDdCYFwvgpuuZ/luRb             oG07uYBm1TfHnrLkuCGOxeP7B8Aa0rY1du7GFwXxYadI21AqrgM+DCJLfX156lil0gL4D/ZMQoTIr1hqDr            9WKv92V3M+H6Gsx7z0iCbn+8Ug=="
}

Example Response

200 Successful Response

422 Validation Error