Introduction

API Reference Guide

API Changelog

API Basics

Authentication & Sandbox Setup

Entity & Metadata

Pagination & Rate Limiting

Best Practices

Glossary

Payments

Orders

Payments

Downtime

Settlements

Instant Settlements

Refunds

Disputes

Documents

Customers

Payment Links

QR Codes

Invoices

Items

Plans

Subscriptions

Add-on

Linked Account

Stakeholder

Product Configuration

Transfers

Smart Collect

Smart Collect With TPV

TPAP Pro

Customer Onboarding

Accounts Management

Payments

Mandates Flow

Bills

About Bills

Bills Entity

Create a Bill

Update a Bill

Delete a Bill

Partners

Account

Product Configuration

Stakeholder

Terms and Conditions

Documents

Webhooks

Payout APIs

Get Started

Account Validation

Composite Account Validation

Contacts

Fund Accounts

Payouts

Payouts to Cards

Payout Composite

Payouts Approval

Payout Idempotency

Payout Links

Payout Wallet - Amazon

Transactions

Api

Payments

Entity

API Test Keys

Payments Entity

The Payments entity has the following parameters:

Is this page helpful?

Success

Failure

1
{
2
  "id": "pay_L0nSsccovt6zyp",
3
  "entity": "payment",
4
  "amount": 9900,
5
  "currency": "MYR",
6
  "status": "captured",
7
  "order_id": "order_L0nS83FfCHaWqV",
8
  "invoice_id": "inv_L0nS7JIyuX6Lyb",
9
  "international": false,
10
  "method": "card",
11
  "amount_refunded": 0,
12
  "refund_status": null,
13
  "captured": true,
14
  "description": "#L0nS7JIyuX6Lyb",
15
  "card_id": "card_L0nSsfPv1LjA20",
16
  "card": {
17
    "id": "card_L0nSsfPv1LjA20",
18
    "entity": "card",
19
    "name": "",
20
    "last4": "1111",
21
    "network": "Visa",
22
    "type": "debit",
23
    "issuer": null,
24
    "international": false,
25
    "sub_type": "consumer",
26
    "token_iin": null
27
  },
28
  "bank": null,
29
  "wallet": null,
30
  "email": "gaurav.kumar@example.com",
31
  "contact": "+9000090000",
32
  "notes": [],
33
  "fee": 198,
34
  "tax": 0,
35
  "error_code": null,
36
  "error_description": null,
37
  "error_source": null,
38
  "error_step": null,
39
  "error_reason": null,
40
  "acquirer_data": {
41
    "auth_code": "299196"
42
  },
43
  "created_at": 1672987417
44
}
id
string

Unique identifier of the payment.

entity
string

Indicates the type of entity.

amount
integer

Payment amount in the smallest currency sub-unit. For example, if the amount to be charged is RM 299.00, then pass 29900 in this field.

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.

Show child parameters (8)

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.

Show child parameters (2)

Payments Entity

The Payments entity has the following parameters:

Is this page helpful?

id
string

Unique identifier of the payment.

entity
string

Indicates the type of entity.

amount
integer

Payment amount in the smallest currency sub-unit. For example, if the amount to be charged is RM 299.00, then pass 29900 in this field.

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.

Show child parameters (8)

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.

Show child parameters (2)

Success

Failure

1
{
2
  "id": "pay_L0nSsccovt6zyp",
3
  "entity": "payment",
4
  "amount": 9900,
5
  "currency": "MYR",
6
  "status": "captured",
7
  "order_id": "order_L0nS83FfCHaWqV",
8
  "invoice_id": "inv_L0nS7JIyuX6Lyb",
9
  "international": false,
10
  "method": "card",
11
  "amount_refunded": 0,
12
  "refund_status": null,
13
  "captured": true,
14
  "description": "#L0nS7JIyuX6Lyb",
15
  "card_id": "card_L0nSsfPv1LjA20",
16
  "card": {
17
    "id": "card_L0nSsfPv1LjA20",
18
    "entity": "card",
19
    "name": "",
20
    "last4": "1111",
21
    "network": "Visa",
22
    "type": "debit",
23
    "issuer": null,
24
    "international": false,
25
    "sub_type": "consumer",
26
    "token_iin": null
27
  },
28
  "bank": null,
29
  "wallet": null,
30
  "email": "gaurav.kumar@example.com",
31
  "contact": "+9000090000",
32
  "notes": [],
33
  "fee": 198,
34
  "tax": 0,
35
  "error_code": null,
36
  "error_description": null,
37
  "error_source": null,
38
  "error_step": null,
39
  "error_reason": null,
40
  "acquirer_data": {
41
    "auth_code": "299196"
42
  },
43
  "created_at": 1672987417
44
}