Skip to main content

List Payments

GET 
/payments

List Payments

Request​

Query Parameters

    page int32

    Default value: 1

    Page to list

    id uuid

    Payment ID to look for

    status Status

    Possible values: [initiated, paid, authorized, failed, refunded, captured, voided, verified]

    Status to filter by

    created[gt] timestamp

    Filter payments equal or greater than a give date

    created[lt] timestamp

    Filter payments equal or less than a give date

    updated[gt] timestamp

    Filter payments updated on a given date or later

    updated[lt] timestamp

    Filter payments updated on a given date or prior

    metadata[key] string

    Filter invoices by a given metadata key. You need to change in the key in the square brackets.

    card_last_digits string

    Possible values: Value must match regular expression ^\d{4}$

    Filter payments by card last digits. Only available for scheme payments: creditcard, applepay, samsungpay, googlepay.

    receipt_no string

    Possible values: Value must match regular expression ^\d{12}$

    Filter payments by RRN or retreival reference number.

Responses​

Successful operation
Schema
    paymentsobject[]

  • Array [

    • id uuidrequired
    status Status (string)required

    Possible values: [initiated, paid, authorized, failed, refunded, captured, voided, verified]

    Indicates the payment status.

    If the payment is in the initiated status, then an action must be taken (e.g. 3DS challenge) in order to complete the payment.

    The status authorized is used when a scheme payment is made with manual: true option which will cause the system to authorize the payment only without capturing it. The merchant must capture the payment within time it will be voided automatically by the issuer. Please note that when an issuer voids the payment, the status will be kept authorized and WILL NOT BE updated by the system.

    amount integerrequired
    fee integerrequired

    Estimated payment fee (including VAT).

    currency Currency (string)required

    ISO-4217 three-letter currency code.

    refunded integerrequired

    Refunded amount. Less than or equal to the payment amount.

    refunded_at timestamp
    captured integerrequired

    Captured amount. Less than or equal to the payment amount.

    captured_at timestamp
    voided_at timestamp
    description string
    amount_format stringrequired

    Formatted payment amount with currency

    fee_format stringrequired
    refunded_format stringrequired
    captured_format stringrequired
    invoice_id uuid

    Invoice ID that this payment is used to pay.

    ip uuidrequired

    Payer IPv4 address. This information is collected from the connection that has created the payment.

    You must ensure that the payment is created from the client device directly to ensure correct collection of the IP address.

    callback_url uri
    created_at timestamprequired
    updated_at timestamprequired
    metadataobject

    A set of key-value pairs where both key and value are strings. Metadata allows you to add more information to the object that will be returned later on in responses and webhook messages. Metadata is searchable using the Payment List API.

    property name* string
    sourceobjectrequired

    Source response object

    oneOf

    type stringrequired

    Possible values: [creditcard]

    company Company (string)required

    Possible values: [mada, visa, master, amex]

    The scheme through which the payment is processed.

    name stringrequired

    Card holder name

    number MaskedPanNumber (string)required

    Masked card number showing first six and last four digits.

    gateway_id stringrequired

    ID used for the backing acquirer gateway (MPG, MPGS or Cybersource).

    token stringrequired

    Token that is created using this payment.

    message stringrequired

    Human readable string representing the transaction result.

    transaction_url urirequired

    3D Secure challenge URL. Only returned when payment is initiated.

    reference_number RetrievalReferenceNumber (string)required

    Possible values: Value must match regular expression ^\d{12}$

    The RRN or retrieval reference number. This is a unique number for the transaction generated by the acquirer gateway and is sent to the issuer during the authorization process.

    This number is not unique across schemes (e.g. Visa and mada).

    This number can be useful in tracking the payment in the card holder account statement.

    authorization_code AuthorizationCode (string)

    Possible values: Value must match regular expression ^\d{6}$

    A six-digit number returned by the issuer in response to a successful authorization process.

    response_code ResponseCode (string)

    A two-digit string representing the authorization result (ISO 8583).

    Response code 00 indicates that the payment is approved by the issuer. Please refer to the response code table in the documentation for more information.

    issuer_name string

    Name of the card issuing bank. This name is inferred based on the card BIN or IIN.

    issuer_country string

    Origin country of the card issuer. A two-letter ISO 3166 code.

    issuer_card_type IssuerCardType (string)

    Possible values: [debit, credit, charge_card, unspecified]

    issuer_card_category IssuerCardCategory (string)

    Indicates the card category or product type, e.g., Platinum, Signature, etc.

    This field is a human readable text and does not have a defined set of values.

  • ]

    • metaobject
    current_page integer
    next_page integer
    prev_page integer
    total_pages integer
    total_count integer
Loading...