Peacock API

To get started with Peacock, connect your current payment processor to our platform. This allows us to pull in your transaction and order data to generate your Peacock Service Panel. Our integration guides provide no-code methods for connecting your payment service providers directly.

If we don't have an integration guide for your processor or you prefer to have full control over the data you send, you can use our Data Ingestion API. We designed this RESTful API to receive and import core objects such as transactions and customers from any payment processor. While we recommend you use our no-code integration, the API approach gives you the flexibility to connect to any number of additional payment systems and partners.

Setting Up and Authenticating

The Pagos platform uses API Keys to authenticate requests to all our services. Click API Keys in the navigation bar of your Peacock Service Panel to view and manage your API keys.

Authentication to the API is performed via HTTPS headers. Provide your API key in the x-api-key header when submitting payment transaction information. You don't need to provide a password.

For example curl -H "x-api-key:[your API key here]" "https://api.pagos.ai/transactions"

Using the Data Ingestion API

You can directly submit transaction information to our systems by making an HTTPS request to the transaction resource of the Pagos APIs. The request will be in type application/json.

POST /transactions

Parameters

None

Responses

HTTPS Response

Description

200

The request was successfully completed.

400

The request was invalid.

401

The request did not include an authentication token or the authentication token was expired.

403

The client did not have permission to access the requested resource.

404

The requested resource was not found.

405

The HTTPS method in the request was not supported by the resource.

409

The request could not be completed due to a conflict.

500

The request was not completed due to an internal error at Pagos

503

The server was unavailable.

Model

{
  "object_id": "string",
  "currency": "str",
  "amount": 0,
  "description": "string",
  "disputed": true,
  "refunded": true,
  "mapped_object": "string",
  "braintree": {
    "braintree_status": "string",
    "network_response_code": "string",
    "network_response_text": "string",
    "channel": "string",
    "is_network_tokenized": true,
    "order_id": "string",
    "processed_with_network_token": "string",
    "processor_authorization_code": "string",
    "processor_response_type": "string",
    "processor_response_code": "string",
    "processor_response_text": "string",
    "processor_settlement_response_code": "string",
    "processor_settlement_response_text": "string",
    "additional_processor_response": "string",
    "sca_exemption_requested": "string",
    "network_transaction_id": "string",
    "acquire_reference_number": "string",
    "recurring": "string",
    "payment_intent": "string"
  },
  "stripe": {
    "stripe_status": "string",
    "outcome_network_status": "string",
    "outcome_reason": "string",
    "outcome_risk_level": "string",
    "outcome_risk_score": 0,
    "outcome_rule": "string",
    "outcome_seller_message": "string",
    "outcome_type": "string"
  },
  "pagos": {
    "pagos_transaction_response_code_id": 0,
    "pagos_transaction_intent_code_id": 0
  },
  "payment_method_details": {
    "instrument_type": "string",
    "object_id": "string",
    "fingerprint": "string",
    "scheme": "string",
    "name": "string",
    "expiry_month": "st",
    "expiry_year": "stri",
    "expiration_date": "string",
    "last4": "stri",
    "masked_number": "string",
    "product_id": "string",
    "bin": "string",
    "type": "string",
    "category": "string",
    "issuer_bank": "string",
    "issuer_country": "string",
    "checks_address_line1_check": "string",
    "checks_address_post_code_check": "string",
    "checks_cvc_check": "string",
    "checks_error_response_code": "string",
    "installments_plan_count": 0,
    "installments_plan_interval": "string",
    "installments_plan_type": "string",
    "three_d_secure_authentication_flow": "string",
    "three_d_secure_result": "string",
    "three_d_secure_result_reason": "string",
    "three_d_secure_version": "string",
    "three_d_secure_info_cavv": "string",
    "three_d_secure_info_ds_transaction_id": "string",
    "three_d_secure_info_eci_flag": "string",
    "three_d_secure_info_enrolled": "string",
    "three_d_secure_info_liability_shift_possible": true,
    "three_d_secure_info_liability_shifted": true,
    "three_d_secure_info_status": "string",
    "three_d_secure_three_d_secure_version": "string",
    "three_d_secure_info_xid": "string",
    "payroll": "string",
    "healthcare": "string",
    "durbin_regulated": "string",
    "verification": "string",
    "account_type": "string"
  },
  "customer_details": {
    "object_id": "string",
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postal_code": "string",
    "country_code_2_letter": "st",
    "country_code_3_letter": "str",
    "country": "string",
    "name": "string",
    "email": "string",
    "company": "string",
    "phone": "string",
    "website": "string"
  },
  "billing_details": {
    "object_id": "string",
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postal_code": "string",
    "country_code_2_letter": "st",
    "country_code_3_letter": "str",
    "country": "string",
    "name": "string",
    "email": "string",
    "company": "string",
    "phone": "string"
  },
  "shipping_details": {
    "object_id": "string",
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postal_code": "string",
    "country_code_2_letter": "st",
    "country_code_3_letter": "str",
    "country": "string",
    "name": "string",
    "email": "string",
    "company": "string",
    "phone": "string",
    "carrier": "string"
  }
}