B2B Customer Care - Configuration

These are important configuration considerations when using the paydiant B2B Customer Care API:

Getting Access

Only authorized Paydiant Issuing Partners are permitted access to the Customer Care APIs. Contact your Paydiant representative for more information about obtaining the credentials required to access these APIs.

Resource URL

Request calls to the B2B Gateway Customer Care API are directed to:

URL/b2b-gateway/customers

where URL is the Resource URL provided by Paydiant at the time of partner onboarding. As appropriate, some calls use

URL/b2b-gateway/partner/...

Authentication Header

All calls to the Customer Care API must be accompanied by an authorization header containing the authorization value provided by Paydiant, encoded per Paydiant’s instructions (typically base64 encoding).

Ignore Unneeded Response Content

When parsing JSON response content, the best practice recommendation is to ignore attributes you are not using. This technique helps avoid problems that may arise when new fields or attributes are added.

Secure Communication

All communication, regardless of transport, needs to run over a TLS encrypted (https) session.

UNIX Timestamp

Many dates in these methods are in UNIX timestamp format. For information on converting UNIX timestamp to human readable values, see http://www.epochconverter.com/.

HTTP Status Codes

The HTTP Status Code indicates only whether the B2B gateway received the transmitted call. The following table lists the HTTP Status Codes that are relevant to the Customer Care API access points:

Error Code Cause of Failure
200 (OK) The gateway received the call and is processing it.
401 (UNAUTHORIZED) Indicates a problem with the authorization header sent with the request, not with the request itself.
404 (SERVICE_UNAVAILABLE) The gateway could not be located. It may either be down or the URL provided in the call is incorrect.
500 (INTERNAL_SERVER_ERROR) An internal server error has occurred.
503 (NOT_FOUND) Connectivity with the server has been interrupted or the operation has timed out.

Note: It is important to remember that the HTTP Status Codes do not indicate a successful result of the request. They indicate only the status of the HTTP event.

For example, an HTTP Status Code of 200, indicates that the request was received by the addressed gateway, but may still result in a failed outcome for the request, if, for example, the request contained invalid arguments or was missing required values. In such cases, the status object returned with the response from the B2B server communicates if the request was successfully carried out.

Attribute Character Lengths

Unless otherwise noted, attribute character fields permit a maximum of 250 characters. In some cases, customer-specific installations may impose stricter maximums. Check with your Paydiant representative for details when in doubt about the amount of characters permitted in a specific field.

Feedback

Have feedback?

Let us know.