B2B Mobile Transaction API - Access Guidelines

The following information is important when accessing the Paydiant B2B Gateway:

Getting access to the B2B gateway endpoints

Only authorized Paydiant Issuing Partners are permitted access to the B2B Gateway API endpoints. Contact your Paydiant representative for more information about obtaining the credentials required to access these APIs.

Resource URL

Request calls to the B2B Gateway Mobile Transaction API endpoints are directed to:

URL/b2b-gateway/v2/endpoint_extension

where URL is the Resource URL provided by Paydiant at the time of partner onboarding and endpoint_extension is the path extension for the specific endpoint documented in this guide.

As appropriate, some calls use

URL/b2b-gateway/partner/...

Authentication header

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

Header Type: Authorization Basic Base64encode
Format: accessid:accessKey
Example: Authorization:Basic eGFPeDl1R2dZYzpGdWVs

Ignore unused response content

When parsing JSON response content, Paydiant recommends ignoring attributes you are not using. This technique helps avoid problems that can arise when new fields or attributes are added.

Secure communication

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

UNIX timestamp

Many dates in these methods are in UNIX timestamp format. For information on converting UNIX timestamps 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 HTTP Status Codes are used by the B2B Mobile Transaction 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 can 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 can 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.

For example, an HTTP Status Code of 200 indicates that the request was received by the addressed gateway; however, the request could still fail if 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 can impose stricter maximums. Check with your Paydiant representative for details when in doubt about the amount of characters permitted in a specific field.

Next

Feedback