Documentation V3
  • Localpayment documentation V3
  • INTRODUCTION TO OUR SOLUTION
    • Intro to our Documentation
    • Intro to Payment Methods in Emerging Markets
    • Merchant Dashboard
      • Dashboard Navigation
      • Login
      • User Roles
      • Roles
      • Users
      • Whitelist your IPs
      • Whitelist your BINs
      • Setup your Webhooks
      • Reports
        • Balance
        • Projected Balance
        • Activity
        • Transaction Detail
        • FIDES Report
      • Virtual accounts
      • Refunds
        • Refund Bank Transfer
        • Refund Card Capture
        • Refund Cash
      • Chargeback
      • Internal Domestic Transfer
      • Internal Foreign Transfer
      • Currency Exchange
        • Create
      • Wire In
      • Wire Out
    • Intro to FX operations
    • Business definitions
      • Payins
      • Payouts
    • Onboarding & Integration
    • Postman Collection
  • ENVIRONMENTS
    • Environments
  • BEFORE A PAYMENT
    • Access Token
    • Validations
      • Document Validation
      • Bank Account Validation
      • Validate BIN
    • Holidays
    • Search Payment Method
    • Search Bank Codes
    • Cash Agents Geolocalization
    • Installments Plan Quote
    • Currency Exchange Quote
    • Billing Service
      • Create
        • Mexico
      • Check Billing status
      • Download Billing
  • REQUEST A PAYMENT
    • Payins
      • Bank Transfer
        • Direct debit
          • DEBIN (Argentina)
          • Transfiya (Colombia)
          • Wallet Fri (Guatemala)
        • Virtual Account
          • Mexico
            • Request Individual
            • Request Batch
            • Check Virtual account
            • Delete Virtual account
            • Enable or Disable Virtual Account
          • Brazil
            • Request Individual
            • Check Virtual account
            • Alias ​​configuration
          • Argentina
            • Request Individual
            • Request Batch
            • Check virtual account
            • Delete Virtual account
          • Refund Virtual Account
        • Online Reference Code Payments
          • Mexico
        • Refund Bank Transfer
        • Cancel
        • APMs
          • CODI (Mexico)
          • ETPAY (Chile)
          • Fintoc (Chile)
          • Boleto (Brazil)
          • PIX (Brazil)
            • Refund Pix
          • PSE (Colombia)
          • QR (Bolivia)
          • QR (Guatemala)
          • QR (Argentina)
          • QR (Perú)
      • Cash
        • Cash
          • APMs
            • Boleto (Brazil)
        • Cancel
        • Refund Cash
      • Debit Card
        • Capture
        • Refund Capture
      • Credit Card
        • Capture
        • Create Authorization
        • Capture Authorization
        • Cancel Authorization
        • Refund Capture
        • Installments
        • Save Cards
          • Save Card
          • Get Card
          • Delete Card
        • 3D-Secure
        • Validate card
        • Chargebacks
          • Notification
          • Send documentation
          • Close Chargeback
    • Payin Subscriptions
      • Create a subscription
      • Update subscription
      • Cancel
    • Payin Subscriptions Plan
      • Create subscription plan
      • Update subscription plan
      • Get subscription plan
    • Payouts
      • Search available banks
      • Create
        • Argentina
        • Bolivia
        • Brazil
        • Chile
        • Colombia
          • Colombia ACH
          • Colombia Transfiya
        • Costa Rica
        • Dominic Republic
        • Guatemala
        • Honduras
        • Mexico
        • Panama
        • Peru
        • Kenya
      • Manual Upload
        • Create Batch Upload
        • Batch Pending Authorization
        • Cancel Batch Pending Authorization
        • Batch Activity
      • Proof of Payment (POP)
      • Cancel
      • Commit payout
      • Attach documents
      • Ripplenet getway
    • Payouts Double Signature
      • Authorize
    • Checkout
      • Webcheckout
        • Credit Card
        • Debit Card
        • Cash
        • Bank Transfer
      • Link Payment
      • Frequent Items
      • Iframe
      • Smart Checkout/ iframe
      • Virtual Pos
      • Plugins
        • Magento
        • Shopify
        • Google Pay
        • WooCommerce
  • AFTER A PAYMENT
    • Check Status
    • Check Payment
    • Check Payment list
    • Check Subscription
    • Account Balance
      • Balance Reconciliation
      • Current Balance Amount
    • Withholding Certificates
    • Proof of Payment
    • RFI - Documentation
  • SETTLEMENT & EXCHANGE
    • Wire In
    • Wire Out
    • Currency Exchange Bulk
      • Quote
      • Bulk
      • Currency exchange - Front end
    • Internal Transfers
      • Internal Domestic Transfer
      • Internal Foreign Transfer
  • NOTIFICATIONS
    • Callbacks - Webhooks
      • Configurations
      • Payins
        • Payin Bank Transfer
        • PSE Colombia
        • Payin Virtual Account
        • Payin Cash
        • Payin Credit Card
        • Payin Debit Card
      • Payouts
    • SFTP- Email Reports
  • API REFERENCE GUIDE
    • Validation Error Codes
    • Transaction Type & Status
      • Payin
      • Subscriptions
      • Payout
      • Chargeback
      • Credit
      • Currency Exchange
      • Debit
      • Expenses
      • Internal Transfer
      • Recall
      • Refund
      • Return
      • Recurring Fee
      • Wire in
      • Wire out
    • Payout Methods + SLA
      • Latam
    • Payin Methods + SLA
      • Argentina
      • Bolivia
      • Brazil
      • Chile
      • Colombia
      • Dominican Republic
      • Guatemala
      • Mexico
      • Panama
      • Peru
    • Currency Codes
      • Latam
    • Country Codes
      • Latam
    • Bank codes
      • Latam
        • Argentina
        • Bolivia
        • Brazil
        • Chile
        • Colombia
        • Costa Rica
        • Dominican Republic
        • Guatemala
        • Honduras
        • Mexico
        • Panamá
        • Peru
    • Bank account validations
      • Latam
        • Argentina
        • Bolivia
        • Brazil
        • Chile
        • Colombia
        • Costa Rica
        • Dominican Republic
        • Guatemala
        • Mexico
        • Panama
        • Peru
    • Document Validations
      • Argentina
      • Bolivia
      • Brazil
      • Chile
      • Colombia
      • Costa Rica
      • Dominican Republic
      • El Salvador
      • Guatemala
      • Honduras
      • Mexico
      • Panama
      • Peru
    • Concept Codes
  • FLOWS AND CHARACTERISTICS
    • Account Currencies
    • Involved Parties
    • Payin Status Flow
      • Payins
        • Payin Status Flow - Card
        • Payin Status Flow - Bank
        • Payin Status Flow -Cash
      • Refund - Card
      • Refund - Cash & Bank
      • Chargeback
    • Payout Status Flow
      • Payout - Bank
      • Return
      • Recall
    • Payin Subscription Flow
      • Payins Subscription Status Flow - Card
    • Virtual Account Status Flow
    • Settlement Status Flow
      • Wire In
      • Wire Out
    • Payin Methods Flow
      • Argentina
      • Bolivia
      • Brazil
      • Chile
      • Colombia
      • Dominican Republic
      • Guatemala
      • Honduras
      • Mexico
      • Panama
      • Peru
  • HOLIDAYS
    • 2021
    • 2022
    • 2023
    • 2024
    • 2025
  • COMPLIANCE
    • Values
    • Prohibited Countries
    • Prohibited Business
    • Compliance Program Docs
    • Licenses
    • Terms & Conditions
  • GLOSSARY
    • Payments Explained
    • FAQ
  • PLUGINS
    • Magento
    • Shopify
    • Google Pay
    • WooCommerce
    • Ripplenet
Powered by GitBook
On this page

Was this helpful?

  1. AFTER A PAYMENT

Check Subscription

Get Subscription

GET https://api.stage.localpayment.com/api/subscriptions/externalID

Get subscription information

Path Parameters

Name
Type
Description

id*

string

Mandatory. Subscription ID as returned by POST method

Headers

Name
Type
Description

Authorization*

string

Mandatory. Bearer JWT token in format Bearer eyJ0... . For more information about authentication, please refer to Authentication.

{
    "externalId": "1623540689",
    "subscriptionId": "ad5bb089-1095-446f-88ca-3bf2fae3610d",
    "status": {
        "code": "202",
        "description": "COMPLETED",
        "detail": "The subscription was completed"
    },
    "totalPayments": 2,
    "pendingPayments": 0,
    "creationDate": "2021-06-12T23:31:29.869+00:00",
    "nextPaymentDate": "2021-03-14T03:00:00.000+00:00",
    "request": {
        "payer": {
            "name": "Fernando",
            "type": "INDIVIDUAL",
            "email": "n.cabral@gmail.com",
            "phone": {
                "number": "98789632",
                "areaCode": "11",
                "countryCode": "1"
            },
            "address": {
                "city": "Temperley",
                "state": "state",
                "number": "1234",
                "street": "Siempre viva",
                "comment": "timbre roto, llamar",
                "country": "Argentina",
                "zipCode": "1686"
            },
            "document": {
                "id": "37993830",
                "type": "DNI"
            },
            "lastname": "Gomez",
            "birthdate": "01/01/1990",
            "nationality": "Argentino",
            "userReference": "identificador del pagador"
        },
        "amount": 150.0,
        "device": {
            "id": "Android 9",
            "ip": "127.111.142",
            "browser": "Google Chrome"
        },
        "comment": "Primer pago",
        "country": "ARG",
        "currency": "ARS",
        "metaData": {
            "algoDelCliente": "informacion adicional del cliente"
        },
        "clientCode": "0002",
        "externalId": "1623540689",
        "beneficiary": {
            "name": "Netflix Argentina1",
            "type": "COMPANY",
            "email": "netflix.argentina@gmail.com",
            "phone": {
                "number": "98789632",
                "areaCode": "11",
                "countryCode": "1"
            },
            "address": {
                "city": "Hurlingham",
                "state": "state",
                "number": "938",
                "street": "Charruas",
                "comment": "portero 801",
                "country": "Argentina",
                "zipCode": "1688"
            },
            "document": {
                "id": "30558251405",
                "type": "CUIT"
            },
            "lastname": "Solo si es type INDIVIDUAL",
            "merchant": "Netflix001",
            "birthdate": "1994-02-20",
            "nationality": "Argentino"
        },
        "conceptCode": "String",
        "accountNumber": "032.032.00000001",
        "autoRecurring": {
            "nextPayment": "2021-01-13",
            "repetitions": 2
        },
        "paymentMethod": {
            "code": "1000",
            "flow": "DIRECT",
            "type": "CreditCard"
        },
        "commercialData": {
            "items": [
                {
                    "id": "PR0001",
                    "title": "Point Mini",
                    "quantity": "1",
                    "unitPrice": 58.8,
                    "categoryId": "electronics",
                    "pictureUrl": "https://http2.mlstatic.com/resources/frontend/statics/growth-sellers-landings/device-mlb-point-i_medium@2x.png",
                    "description": "Producto Point para cobros con tarjetas mediante bluetooth"
                }
            ],
            "invoice": "Refencia a una factura",
            "shipments": [
                {
                    "city": "Temperley",
                    "state": "state",
                    "number": "1234",
                    "street": "Siempre viva",
                    "comment": "timbre roto, llamar",
                    "country": "Argentina",
                    "zipCode": "1686"
                }
            ]
        },
        "intermediaries": [
            {
                "name": "Fernando",
                "type": "INDIVIDUAL",
                "email": "n.cabral@gmail.com",
                "phone": {
                    "number": "98789632",
                    "areaCode": "11",
                    "countryCode": "1"
                },
                "address": {
                    "city": "Temperley",
                    "state": "state",
                    "number": "1234",
                    "street": "Siempre viva",
                    "comment": "timbre roto, llamar",
                    "country": "Argentina",
                    "zipCode": "1686"
                },
                "document": {
                    "id": "37993830",
                    "type": "DNI"
                },
                "lastname": "Gomez",
                "birthdate": "01/01/1990",
                "nationality": "Argentino"
            }
        ],
        "exchangeRateToken": "String"
    },
    "payments": [
        {
            "internalId": "9341125e-6f24-4141-adb5-b2e555d58558",
            "status": {
                "code": "103",
                "description": "APPROVED",
                "detail": "The payin was confirmed but not credited yet"
            }
        },
        {
            "internalId": "887517fe-d052-4634-8d85-f1e632d3357e",
            "status": {
                "code": "103",
                "description": "APPROVED",
                "detail": "The payin was confirmed but not credited yet"
            }
        }
    ],
    "retries": 0
}
{
    "status": {
        "code": "404",
        "description": "ERROR",
        "detail": "Subscription not found"
    }
}
curl --location --request GET 'https://api.stage.localpayment.com/api/subscriptions/1662558201' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjYyNjUyNTYyLCJqdGkiOiJmZGM3NzMzNWYwNWY0YTg1OTg1NzM0ZTg0NmU3OTg4OSIsInVzZXJfaWQiOjMwLCJzdXBlcnVzZXIiOnRydWUsImlzX3N0YWZmIjpmYWxzZSwicm9sZXMiOlsiQUxMIl0sImNvdW50cmllcyI6WyJBTEwiXSwiY29tcGFueSI6IjAwMDEiLCJjbGllbnRfY29kZSI6IjAwMDEifQ._wpnC6r02XdGRhcEYx-sWEB3dj8OzuuurglgnI2jSJ4'
{
    "externalId": "1662558201",
    "internalId": "38a16a07-6616-4a90-82b9-0d7c8e2a2b76",
    "country": "ARG",
    "currency": "ARS",
    "accountNumber": "032.032.00000015",
    "status": {
        "code": "105",
        "description": "INPROGRESS"
    },
    "date": {
        "creationDate": "2022-09-07 13:43:52.932",
        "nextPaymentDate": "2022-09-09T13:43:52.567Z"
    },
    "payments": [
        {
            "externalId": "8708a8ad-806b-4487-a0ce-ea6344d5b347",
            "internalId": "ede1a29c-6e68-49ef-a5a7-e6be3a21251b",
            "status": {
                "code": "103",
                "description": "APPROVED",
                "detail": "The payin was confirmed but not credited yet"
            }
        },
        {
            "externalId": "24f28300-a100-40a6-9344-4d337758d2d5",
            "internalId": "9bbd8079-8f48-4977-8cd4-1732c90650dd",
            "status": {
                "code": "103",
                "description": "APPROVED",
                "detail": "The payin was confirmed but not credited yet"
            }
        }
    ]
}
PreviousCheck Payment listNextAccount Balance

Last updated 1 year ago

Was this helpful?