Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Abstract

This document describes Billpocket’s API for online transaction processing, which allows 3rd-Party entities to securely process transactions by providing details about the card and the amount to be charged.

...

You must not supply the fields “contractNumber" nor “paymentPlan" if you indicate this value.

  • recurring

Not supported by AMEX cards: AMEX doesn’t support recurring transactions. However if it is required to send an AMEX transaction without the 4dbc it could be achieved by a tokenized card authorization request (2.2).

You must supply the field “contractNumber" and must not supply a “paymentPlan" if you indicate this value.

  • recurringCheckIn

Not supported by AMEX cards

You must supply the field “contractNumber" and must not supply a “paymentPlan" if you indicate this value.

...

2.3 Special recurring transactions for tokenized cards (development)

URL: /txn/recurring

Not supported by AMEX cards

It is an extension to the functionality offered by /txn since it additionally supports expired cards by automatically setting current month number + 1 in case the card is expired, otherwise, it behaves the same as /txn

...

2.5 Special recurring transactions for NON tokenized cards (development)

URL: /txn/recurring

Not supported by AMEX cards

It is an extension to the functionality offered by /txn since it additionally supports expired cards by automatically setting the current month number + 1 in case the card is expired, otherwise, it behaves the same as /txn

...

Checkout URL: /txn/checkout

Process a full or partial refund or checkout for a previously approved transaction. Note that you can refund transactions processed with tokenized or not-tokenized cards with this endpoint

...

Code Block
languagejson
{
  "apiKey" : "myAPIKey", // (String) Your API access key
  "opId" : 102030, // (integer) Unique identifier for the processed transaction
  "amount" : 999.00 // (double) Amount to be refunded/checked-out. If null, a full refund or checkout will be executed. If an amount less than the original is sent, a partial refund or checkout will be executed.
}

Info

NOTE: For partial refunds or checkouts, an amount less than the original transaction must be sent. If the amount field is sent as null, then a full refund or checkout will be executed. The amount field is required.

Below you can find the amount of days available to perform the corresponding check-out operation

Panel
panelIconId1f4b3
panelIcon:credit_card:
panelIconText💳
bgColor#DEEBFF

20 days - Credit and debit cards

If you don't make the check-out process within that time, the funds retained will be released by the issuing bank back to the cardholder.

...

Response Format Success: HTTP 200 (OK)

Code Block
languagejson
{
  "status" : 1, // (integer) 1=Success Else=Error
  "message" : "An error has ocurred", // (String) Error description
  "opId" : 102031, // (integer) Unique identifier for the processed transaction
  "txnISOCode" : "05", // (String) ISO Code of the transaction response
  "maskedPAN" : "555555******5555", // (String) Masked Card Number used for this transaction
  "dateTime" : 1601075048000 // (long) Timestamp for this operation (Unix Epoch, milis)
}

Request Error (HTTP 400: Bad Request)

...