Paylands concepts
Environments
In Paylands we have two different environments to make requests to: Sandbox and Production. Each of these environments must be called with different data, i.e. the API KEY, the service, order or card identifiers will be different depending on the environment in which the call is made.
Sandbox environment
The Sandbox environment is an environment created for system testing. This environment is usually used for gateway integration, and all operations performed in this environment are done through the test services, so payments made through this environment do not handle real money.
In this environment, specific test cards must be used, in order to control the different responses that can be received (SUCCESS, ERROR...).
The URL of this environment is: https://api.paylands.com/v1/sandbox/
Production environment
The Production environment is the final environment of the system. All payments made in this environment are handled with real money. Therefore, since transactions in this environment already contact the issuing bank of the cards used, they must be real cards.
The URL of this environment is: https://api.paylands.com/v1/
Operational
The operations indicate the types of payments that can be made through the platform.
The type of operative is specified by the operative attribute in the order creation call to /payment. Once the order operation has been configured, the request must be sent to the corresponding endpoint in order to perform the subsequent actions.
These endpoints, the parameters they receive and all the necessary information can be found in the Payments section.
Below we indicate the actions that can be performed by each operation.
Authorization
Collection order effective at the time of the transaction.
| Code | Description |
|---|---|
| AUTHORIZATION | Performs a payment on the created order. The URL is /payment/direct |
| REFUND | Performs a total or partial refund of a payment. The URL is /payment/refund |
Deferred
Allows a charge to be sent for later confirmation. It does not perform any check or debit.
| Code | Description |
|---|---|
| CONFIRMATION | Enforces the previously held charge. The URL is /payment/confirmation |
| CANCELLATION | Releases the previously held amount (if not yet confirmed). The URL is /payment/cancellation |
| REFUND | Performs a full or partial refund after a confirmation of a hold. The URL is /payment/refund |
Payout
Allows you to deposit an amount of money to a card. Depending on the acquirer, the card may need to have been previously operated on the terminal.
| Code | Description |
|---|---|
| PAYOUT | Credit the card. The URL where to make the request is /payment/payout |
Transfer
Allows you to make a money transfer to a specific destination.
| Code | Description |
|---|---|
| TRANSFER | Make the transfer. The URL is /payment/transfer |
| CANCELLATION | If possible, performs the cancellation of the transfer. The URL is /payment/transfer/cancellation |
Order statuses
During the payment process, orders change status to reflect information about the payment, that information is in the status field of the order object.
The Order status can have the following values:
| Value | Description |
|---|---|
| BLACKLISTED | Operation rejected by the black list |
| CANCELLED | Preauthorization cancelled by client |
| CREATED | Payment Order Initiated |
| EXPIRED | Transaction that has been too long on card hold |
| FRAUD | Transaction rejected by the anti-fraud system |
| PARTIALLY_REFUNDED | Partially refunded transaction |
| PARTIALLY_CONFIRMED | Preauthorization partially confirmed |
| PENDING_CONFIRMATION | Preauthorization that has placed a hold on the user's account and is waiting for the customer to confirm the hold |
| REFUNDED | The transaction has been returned |
| SUCCESS | Successfully completed transaction |
| REFUSED | Transaction rejected by bank |
| PENDING_PROCESSOR_RESPONSE | Transaction without 3DS that has been sent to the processor |
| PENDING_3DS_RESPONSE | User is on 3DS |
| PENDING_CARD | User is on the payment card inserting his card |
| USER_CANCELLED | The user has canceled the payment from the payment card |
| REDIRECTED_TO_3DS | Payment has been attempted but for security reasons the user must manually authorize the payment. |
| AUTHENTICATION_REQUIRED | The bank has required authentication for this transaction and is waiting for the user to access the 3DS |
| PENDING_PAYMENT | The user has provided all the necessary data to carry out the payment, and is awaiting confirmation from the payment provider. |
| THREEDS_EXPIRED | The transaction has arrived on 3DS but the user has abandoned the process, and has not been authenticated |
Transaction status
Like orders, transactions also reflect transaction status information in the status field of the transaction object.
These are the values you can find in a Transaction:
| Value | Description |
|---|---|
| CREATED | When we have not yet received a response from the acquirer with the final result of the transaction. |
| SUCCESS | The transaction has arrived at the processor and has been successfully completed. |
| REFUSED | The transaction has arrived at the processor but has been completed incorrectly (incorrect card, insufficient funds, etc.). |
| ERROR | The transaction could not be completed due to an error in the service configuration. |
| PENDING | When the transaction is pending to be validated by the processor |
| CANCELLED | When the transaction has been rejected by the processor. |