Sign in

v1

latestOpenAPI 3.1.02026-07-2663312285.4 KB
Payment Agreements

Retrieve a Payment Agreement

get/v1/payment-agreements/{agreement-id}

Path parameters

agreement-idstring required

Headers

Merchant-Idstring required

The merchant identifier.

Response

OK

idstring

The payment agreement ID

status'INITIALIZING' | 'AUTHENTICATION_PENDING' | 'AUTHORIZATION_PROCESSING' | 'ACTIVE' | 'REVOKED_BY_CONSUMER' | 'REVOKED_BY_MERCHANT' | 'REVOKED_BY_PROVIDER' | 'FAILED'

The payment agreement status

descriptionstring

The description of the agreement

merchantPaymentAgreementReferencestring

The merchant payment agreement reference

paymentMethodstring

The payment method which was used to process the payment charge.

startDatestring date-time

The start date of the agreement

endDatestring date-time

The end date of the agreement

instrumentIdstring

The ID of the payment instrument associated with the agreement.

instrumentUpdatedboolean

Indicates that the Payment Instrument has been updated during processing. Query Payment Instruments to retrieve the new details.

amountType'MAX' | 'EXACT' | 'VARIABLE'

Defines if the provided 'amount' is a maximum value or an exact value.

initialPaymentChargeIdstring

The payment charge ID of the initial charge generated by this agreement

initialSchemeAuthorizationReferencestring

The initial scheme authorization reference, eg. for cards network transaction identifier (NTI)

initialTransactionLinkReferencestring

Transaction Link Reference or Id (ex: Mastercard TLID) is a unique identifier for a transaction, used by some card networks for transaction chain linking, this is in addition to Network Transaction Identifiers. Provide the initial TLID when creating the subsequent Merchant-Initiated-Transactions.

createdAtstring date-time

The agreement creation timestamp in ISO 8601 format.

updatedAtstring date-time

The agreement update timestamp in ISO 8601 format.

labelsobject

Custom labels associated with this payment agreement.

Example response

{
  "id": "agr_pmCQxjxTj35kx6KaSgOJh",
  "status": "ACTIVE",
  "paymentMethod": "UPI_AUTOPAY",
  "frequency": {
    "type": "MONTHLY",
    "interval": 3
  },
  "startDate": "2023-03-26T20:24:27.123Z",
  "endDate": "2023-03-26T20:24:27.123Z",
  "amount": {
    "value": 1000,
    "currency": "EUR"
  },
  "consumer": {
    "name": "John Smith",
    "email": "johnsmith@example.com",
    "phone": "+491521111111",
    "country": "DE",
    "locale": "de-DE",
    "taxIdentification": "0798154336790",
    "merchantConsumerReference": "5c019979-0751-469e-96e0-b67f1d95c577",
    "billingAddress": {
      "street": "123 Main St",
      "city": "Anytown",
      "region": "CA",
      "postalCode": "12345",
      "country": "US"
    },
    "client": {
      "ip": "11.22.22.33",
      "userAgent": "Mozilla/5.0 (X11; CrOS x86_64 8172.45.0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.64 Safari/537.36"
    }
  },
  "authenticationMethods": [
    {
      "details": {
        "mobileIntentUri": "upiGlobal://pay?tr=123&from_app=true"
      }
    }
  ],
  "history": [
    {
      "id": "ahist_ufJuwjMY21NVK4dkjee3",
      "status": "SUCCEDED",
      "createdAt": "2023-03-26T20:24:27.123Z"
    }
  ],
  "revocations": [
    {
      "id": "rev_ufJuwjMY21NVK4dkjee3",
      "revocationStatus": "REVOKED_BY_MERCHANT",
      "createdAt": "2023-03-26T20:24:27.123Z"
    }
  ],
  "initialSchemeAuthorizationReference": "XPTO",
  "initialTransactionLinkReference": "atf3_8msFoZ6klReRDlQwn",
  "createdAt": "2023-03-26T20:24:27.123Z",
  "updatedAt": "2023-03-26T20:24:27.123Z"
}