API Reference

Card

Payment


Card is one of the payment methods available in the create payment service. The debt is paid by a credit card.

Status

Status

Reason

Description

Opened

The order was created and inprogress.

Authorized

The order was authorized.

Collected

The order was created and paid for.

Cancelled

The state of an Opened order that expired or was cancelled by calling cancelation operation.

Voided

The state of an Authorized order that expired or was voided by calling cancelation operation.

Failed

Rejected

The transaction was declined. The acquirer does not allow this transaction to be processed.

Failed

InsufficientFunds

The transaction was declined because the card has insufficient Funds.
Please, try a different card.

Failed

InvalidCard

The transaction was declined because the card details are invalid. Please, try again.

Failed

Referred

The transaction was declined. The customer should contact their bank.

Failed

ExpiredCard

The transaction was declined because the card is expired.Please, try a different card.

Failed

InvalidConfiguration

The transaction was declined due to a processing error. Contact koin for more details

Failed

Undefined

The transaction was declined due to an unexpected error.

Failed

StolenCard

The transaction was declined because the card is reported as stolen, related to fraud. Please, try a different card.

Failed

Connection Rejected

The transaction was declined due to a processing error. The acquirer and supplier are working on it.

Failed

InvalidData

The transaction was declined due to a processing error. Contact koin for more details

Failed

Antifrad

The transaction was declined for antifraud.

When the order status changes a webhook notification will be sent.

Workflow

In this section you can find information about Card workflow for different scenarios.

Authorization:

Capture:

Void:

Authorized Failed:

Capture Failed:

Refund:

Testing environment

In order to test all scenarios in a testing environment, you can use the order amount to force the order status in the create payment response. For example, if the order amount is less than 5001, the order status will be "Authorized" and after a couple of minutes, it will capture and change to "Collected". In the table below you can find other options.

AmountResponse statusStatus changeResponse reason
Amount <= 5.000AuthorizedCollected
5.001 - 10.000AuthorizedFailedChannelRejected
10.001 - 15.000AuthorizedFailedInsufficientFunds
15.001 - 20.000AuthorizedFailedInvalidCard
20.001 - 25.000AuthorizedFailedInvalidData
25.001 - 30.000AuthorizedFailedReferred
30.001 - 35.000AuthorizedFailedExpiredCard
35.001 - 40.000AuthorizedFailedStolenCard
40.001 - 45.000AuthorizedFailedConnectionRefused
45.001 - 50.000AuthorizedFailedInvalidConfiguration
50.001 - 55.000AuthorizedFailedUndefined
56.001 - 57.000ConnectionRefusedFailedReferred
57.001 - 58.000ConnectionRefusedAuthorizedAuthorized
58.001 - 59.990ConnectionRefusedFailedExpiredCard
60.000 - 65.000OpenedAuthorized
65.001 - 70.000UnknownAuthorized
Amount > 150.000AuthorizedCollected

Refund


Card is also available in the refund service. It can be used to reimburse totally or partially previously collected orders.

Status

StatusDescription
OpenedRefund order in process.
RefundedRefund order completed.
FailedSomething went wrong the refund order failed.

Testing environment

StatusResponse status
2.500 >= Amount > 5.000Refunded
2.500 < Amount <= 5.000Failed