Getnet DocsGetnet Docs

Get All Charges

GET/rpy/adapter-charge/v1/charges

__List All Charges__<br> <br>This endpoint retrieves a list of all registered charges in the system. You can apply various filters to narrow down the results, such as filtering by subscription, customer, charge status, and dates.<br> <br>**Usage Scenarios:**<br>_- Viewing all charges within a certain time period.<br>- Filtering charges by subscription, customer, or plan.<br>- Monitoring charge statuses (e.g., pending, paid, failed).<br>- Exporting charge data for analysis or reporting._

Query Parameters

pageinteger
limitinteger
retriesinteger
plan_idstring
subscription_idstring
start_datestring
end_datestring
sortstring
sort_typestring
statusstring
scheduled_datestring
charge_idstring
customer_idstring
seller_idstring
payment_typestring

Type of payment. Comma delimited.

Response

Request executed successfully

seller_idstring<uuid>
order_idstring
payment_idstring<uuid>
amountinteger<int32>
currencystring
status"pending" | "canceled" | "approved" | "denied" | "authorized" | "confirmed" | "expired" | "unprocessed"
payment_received_timestampstring<date-time>
creditobject
Show credit properties
delayedboolean
authorization_codestring
authorization_timestampstring<date-time>
reason_codestring
reason_messagestring
acquirerstring
soft_descriptorstring
brand"Mastercard" | "Visa" | "Amex" | "Elo" | "Hipercard" | "Maestro"
terminal_nsustring
acquirer_transaction_idstring
transaction_idstring
debitobject
Show debit properties
delayedboolean
authorization_codestring
authorization_timestampstring<date-time>
reason_codestring
reason_messagestring
acquirerstring
soft_descriptorstring
brand"Mastercard" | "Visa" | "Amex" | "Elo" | "Hipercard" | "Maestro"
terminal_nsustring
acquirer_transaction_idstring
transaction_idstring
errorobject
Show error properties
status_codeinteger<int32>
namestring
messagestring
detailsobject[]
Show details properties
acquirer_transaction_idstring
descriptionstring
description_detailstring
error_codestring
payment_idstring
statusstring
terminal_nsustring

Invalid request.

statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

Invalid authentication. Check your credentials or contact the Getnet Relationship Center.

statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

Not found

statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

Unprocessable Entity

messagestring

Detailed error message.

namestring

Name of the module or system in which the error occurred.

status_codeinteger<int32>

HTTP status code of the error.

detailsobject[]

Error details.

Show details properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

paymentsobject[]

Error details.

Show payments properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

combined_idstring

combinedId.

order_idstring

orderId.

seller_idstring

sellerId.

Internal server error. Please try again later.

statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

The server encountered a temporary error and did not complete the request. Please try again later.

statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

Request
curl -X GET "https://api.pre.globalgetnet.com/rpy/adapter-charge/v1/charges?page=<page>&limit=<limit>&retries=<retries>&plan_id=<plan_id>&subscription_id=<subscription_id>&start_date=<start_date>&end_date=<end_date>&sort=<sort>&sort_type=<sort_type>&status=<status>&scheduled_date=<scheduled_date>&charge_id=<charge_id>&customer_id=<customer_id>&seller_id=<seller_id>&payment_type=<payment_type>"
Response
{
  "seller_id": "00000000-0000-0000-0000-000000000000",
  "order_id": "string",
  "payment_id": "00000000-0000-0000-0000-000000000000",
  "amount": 0,
  "currency": "string",
  "status": "pending",
  "payment_received_timestamp": "1970-01-01T00:00:00.000Z",
  "credit": {
    "delayed": true,
    "authorization_code": "string",
    "authorization_timestamp": "1970-01-01T00:00:00.000Z",
    "reason_code": "string",
    "reason_message": "string",
    "acquirer": "string",
    "soft_descriptor": "string",
    "brand": "Mastercard",
    "terminal_nsu": "string",
    "acquirer_transaction_id": "string",
    "transaction_id": "string"
  },
  "debit": {
    "delayed": true,
    "authorization_code": "string",
    "authorization_timestamp": "1970-01-01T00:00:00.000Z",
    "reason_code": "string",
    "reason_message": "string",
    "acquirer": "string",
    "soft_descriptor": "string",
    "brand": "Mastercard",
    "terminal_nsu": "string",
    "acquirer_transaction_id": "string",
    "transaction_id": "string"
  },
  "error": {
    "status_code": 0,
    "name": "string",
    "message": "string",
    "details": [
      {
        "acquirer_transaction_id": "string",
        "description": "string",
        "description_detail": "string",
        "error_code": "string",
        "payment_id": "string",
        "status": "string",
        "terminal_nsu": "string"
      }
    ]
  }
}