Skip to content
/
Quick reference
Last updated

Quick reference

Base URLs

EnvironmentURL
Sandboxhttps://api.dev.paradisegateway.net
Productionhttps://api.paradisegateway.net

Authentication

MethodHeaderWhen to use
API KeyAPIKEY: YOUR-API-KEYAll transactional and reporting endpoints
Basic AuthAuthorization: Basic base64(user:pass)Password management, key retrieval

Endpoint cheat sheet

Transactions

ActionMethodEndpoint
Create transactionPOST/v1/transactions
List transactionsGET/v1/transactions
Retrieve transactionGET/v1/transactions/{id}
Update transactionPOST/v1/transactions/{id}
Capture authorizationPOST/v1/transactions/{id}/capture
Cancel or refundPOST/v1/transactions/{id}/cancel

Payment Tokens

ActionMethodEndpoint
Create tokenPOST/v1/payment_tokens
List tokensGET/v1/payment_tokens
Retrieve tokenGET/v1/payment_tokens/{token}
Update tokenPOST/v1/payment_tokens/{token}
Delete tokenDELETE/v1/payment_tokens/{token}

Clients

ActionMethodEndpoint
Create clientPOST/v1/clients
List clientsGET/v1/clients
Retrieve clientGET/v1/clients/{id}
Update clientPOST/v1/clients/{id}

Users

ActionMethodEndpoint
Create userPOST/v1/users
List usersGET/v1/users
Retrieve userGET/v1/users/{id}
Update userPOST/v1/users/{id}
Update passwordPATCH/v1/users/me/passwords

Integrations

ActionMethodEndpoint
Create integrationPOST/v1/integrations
List integrationsGET/v1/integrations
Retrieve integrationGET/v1/integrations/{id}
Update integrationPOST/v1/integrations/{id}

Batches

ActionMethodEndpoint
List batchesGET/v1/batches
Batch settlement statusGET/v1/batches/status
Close batchPUT/v1/batches/status

MFA

ActionMethodEndpoint
Request OTPPOST/v1/mfa/challenges
Verify OTPPOST/v1/mfa/verifications

Auth

ActionMethodEndpoint
Retrieve API keyPOST/v1/auth/keys

Query parameters for list endpoints

ParameterTypeDefaultDescription
skipstring0Number of records to skip
takestring25Records per page
sort_columnstringvariesColumn to sort by
sort_orderstringdescasc or desc
search_textstring—Free-text search
termstring—Filter term

Test card numbers

Use these card numbers in the sandbox environment only. Any expiry date in the future and any 3-digit CVV will work.

Approved transactions

Card brandNumberResult
Visa4111111111111111Approved
Visa4012888888881881Approved
Mastercard5431111111111111Approved
Mastercard5105105105105100Approved
American Express341111111111111Approved
Discover6011111111111117Approved

Declined transactions

Card brandNumberResult
Visa4000000000000002Declined
Mastercard5200000000000007Declined

AVS test scenarios

AddressZIPExpected AVS result
123 Main St62704y — full match
999 Wrong Ave62704z — ZIP match only
123 Main St00000a — address match only
999 Wrong Ave00000n — no match

Test bank accounts

Use these bank account details in the sandbox environment only.

Routing numberAccount numberAccount typeResult
021000021123456789012checkingApproved
021000021987654321098savingsApproved
021000021000000000001checkingDeclined

Amount format

All monetary amounts are integers in minor units (cents for USD).

Display amountAPI value
$1.00100
$19.991999
$100.0010000
$999,999.9999999999

Minimum transaction amount: $0.50 (50).

HTTP status codes

CodeMeaning
200Success
201Created (user accounts, payment tokens)
400Bad request — invalid parameters
401Unauthorized — invalid or missing API key
404Resource not found
422Validation failed (for example, invalid card number)

ID formats

ObjectPrefixExample
TransactionTRANSACTION-TRANSACTION-01KEW32V6YNV11T33XGDR7TGWC
ClientCLIENT-CLIENT-3MtwBwLkdIwHu7ix28a3tqPa
UserUSER-USER-3MtwBwLkdIwHu7ix28a3tqPa
Payment TokenPAYMENT_TOKEN-PAYMENT_TOKEN-01KFDKXMQ637EKEAY410MSQSXB
Integration (TSYS)proc_proc_3MtwBwLkdIwHu7ix28a3tqPa
Integration (Vericheck)INTEGRATION-INTEGRATION-01KFDKXMQ637EKEAY410MSQSXB
Batchbatch_batch_01KFDKXMQ637EKEAY410MSQSXB

Overview

TSYS test cards