API Credentials

PaySimple assigns API credentials to each merchant or reseller account. Your production API username and API key will be delivered via encrypted email. Please ensure the API key is stored encrypted in a secured location on your server, and never sent to a browser or via unencrypted email.

The API key is the same as the key issued for API4, however the method used to generate the authorization header differs.

Authorization Header

PaySimple requires an Authorization Header to be included in each request your backend service makes to API version 5. The header value will vary in format depending if you are using a merchant or reseller key.

Merchant Authorization

PaySimple uses Basic access authorization for merchant access to the API. Use your PaySimple API username as the user name and API key as the password.

Example Merchant Authentication Header:

basic APIUser1225:YhLB81Vofv6Zndxc6QLkdmbaKwdKPawyoKOJ6eWrBJYmDPIKNWTDtwbvkcDIbVR0pVR8RYJKOfIskjBiDtdSV4d1R2FzEv3hmCtlTjdmgpQg41vhscg5juCO0tqTE6r0

Reseller Authorization

If you are issued a reseller API key, input the string reseller as the authentication header scheme, followed by a space an the reseller API key. You can then access reseller level API endpoints.

Example Reseller Authentication Header:

reseller 218|YhLB81Vofv6Zndxc6QLkdmbaKwdKPawyoKOJ6eWrBJYmDPIKNWTDtwbvkcDIbVR0pVR8RYJKOfIskjBiDtdSV4d1R2FzEv3hmCtlTjdmgpQg41vhscg5juCO0tqTE6r0

If your software requires an operation on behalf of one or your merchants, add a header with key PaySimple-Merchant-Id and the PaySimple Merchant Id of the merchant for the value.