Skip to main content

List Settlement Lines

GET 
/settlements/:id/lines

List Settlement Lines

Request​

Path Parameters

    id uuidrequired

    ID of the settlement to list lines for

Query Parameters

    page int32

    Default value: 1

    Page to list

Responses​

Successful operation
Schema
    linesobject[]

  • Array [

    • payment_id uuid

    Payment ID this line is related to

    type string

    Possible values: [payment, refund, void, fee, platform_duties, other_duties, chargeback, chargeback_penalty, installment]

    The type of operation settled:

    • payment: A successful payment or a captured transaction.
    • refund: A payment that has been refunded to the payer.
    • void: A canceled payment that does not incur any fees, unlike a refund.
    • fee: A service fee charged by the platform for processing a payment.
    • platform_duties: Additional charges taken from entity and paid to the platform.
    • other_duties: Miscellaneous additional charges that do not fall into specific categories.
    • chargeback: A refunded payment due to a chargeback dispute.
    • chargeback_penalty: A penalty fee charged when a client loses a chargeback dispute.
    • installment: A recurring payment deducted as part of a loan repayment through a partner.
    currency Currency (string)

    ISO-4217 three-letter currency code.

    payment_amount integer

    Total payment amount

    amount integer

    Net amount settled to the merchant. This can be a negative value.

    fee integer

    Transaction fee including TAX

    tax integer

    VAT

    reference_number RetrievalReferenceNumber (string)

    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.

    ip ipv4

    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.

    transacted_at timestamp

    Date and time when the transaction being settled occured.

    • If the transaction is a purchase, then this value equals to created_at from the payment object.
    • If the transaction is a result of a capture, then captured_at is shown here.
    • If refund, then refunded_at is used.
    • If void, then voided_at is used.
    splits array

    Added for a future feature. This will be null for now. Can be ignored when deserializing.

    custom_splits array

    Added for a future feature. This will be null for now. Can be ignored when deserializing.

    sourceobject

    Source response object

    oneOf

    type string

    Possible values: [creditcard]

    company Company (string)

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

    The scheme through which the payment is processed.

    name string

    Card holder name

    number MaskedPanNumber (string)

    Masked card number showing first six and last four digits.

    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.

    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

  • ]

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