Api

Payments

Payments

Capture and fetch Payments using Curlec APIs.

Payments APIs are used to capture and fetch payments. You can also fetch payments based on orders and card details of payment.

Watch Out!

You can use Payments API only to retrieve payment details or change the status from authorized to captured and not to collect payments. You can use one of the

Curlec products
to accept payments.

List of Endpoints

API EndpointDescription

Capture a Payment

Captures a payment.

Fetch a Payment With ID

Retrieves details of a specific payment using id.

Fetch a Payment (With Expanded Card Details)

Retrieves details of all the payments that is created, with the card parameter.

Fetch All Payments

Retrieves details of all payments.

Fetch All Payments (With Expanded Card Details)

Retrieves expanded card details of a payment.

Fetch Payments Based on Orders

Retrieves payments linked to an Order.

Fetch Card Details of a Payment

Retrieves card details of a payment

Update a Payment

Edits an existing payment.

Payments Entity

The Payments entity has the following fields:

id

string Unique identifier of the payment.

entity

string Indicates the type of entity.

amount

integer The payment amount in currency subunits. For example, for an amount of RM 1.00 enter 100.

currency

string The currency in which the payment is made.

status

string The status of the payment. Possible values:

  • created
  • authorized
  • captured
  • refunded
  • failed

method

string The payment method used for making the payment. Possible values:

  • card
  • fpx
  • wallet

order_id

string Order id, if provided. Know more about

Orders

.

description

string Description of the payment, if any.

international

boolean Indicates whether the payment is done via an international card or a domestic one.

refund_status

string The refund status of the payment. Possible values:

  • null
  • partial
  • full

amount_refunded

integer The amount refunded in currency subunits. For example, if amount_refunded = 100, it is equal to RM 1.00.

captured

boolean Indicates if the payment is captured.

email

string Customer email address used for the payment.

contact

string Customer contact number used for the payment.

fee

integer Fee (including tax) charged by Curlec.

tax

integer Tax charged for the payment.

error_code

string Error that occurred during payment. For example, BAD_REQUEST_ERROR.

error_description

string Description of the error that occurred during payment. For example, Payment processing failed because of incorrect OTP.

error_source

string The point of failure. For example, customer.

error_step

string The stage where the transaction failure occurred. The stages can vary depending on the payment method used to complete the transaction. For example, payment_authentication.

error_reason

string The exact error reason. For example, incorrect_otp.

notes

json object Contains user-defined fields, stored for reference purposes.

created_at

integer Timestamp, in UNIX format, on which the payment was created.

card_id

string The unique identifier of the card used by the customer to make the payment.

card

object Details of the card used to make the payment.

id

string The unique identifier of the card used by the customer to make the payment.

entity

string The name of the entity. Here, it is card.

name

string Name of the cardholder.

last4

integer The last 4 digits of the card number.

network

string The card network. Possible values:

  • MasterCard
  • Visa

type

string The card type. Possible values:

  • credit
  • debit
  • prepaid
  • unknown

issuer

string The card issuer. The 4-character code denotes the issuing bank.

Handy Tips

This attribute will not be set for the card issued by a foreign bank.

sub_type

string The sub-type of the customer's card. Possible values:

  • customer

  • business

    Handy Tips

    Know how to accept payments made by customers using

    corporate cards

    .

bank

string The 4-character bank code which the customer's account is associated with.

wallet

string The name of the wallet used by the customer to make the payment. For example, grabpay.

acquirer_data

array A dynamic array consisting of a unique reference number.

rrn

string A unique bank reference number provided by the banking partner when a refund is processed. This reference number can be used by the customer to track the status of the refund with the bank.

bank_transaction_id

string A unique reference number provided by the banking partner in case of fpx payments.

Webhooks

Set up webhooks

to configure and receive notifications when a specific

event

occurs. When one of these events is triggered, we send an HTTP POST

payload

in JSON to the webhook's configured URL.

Was this page helpful?

ON THIS PAGE