{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Reference accounts payments API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "payments",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List ACH Responses",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://host.com/v2/payments/ach/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "A page number within the paginated result set."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Number of results to return per page."
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "A search term."
              }
            ]
          },
          "docs": "Get the ach payment information"
        },
        {
          "info": {
            "name": "Create Create ACH Request",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://host.com/v2/payments/ach/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create an ACH request to move funds into or out of a DDA inside of CRB"
        },
        {
          "info": {
            "name": "Retrieve ACH Response",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://host.com/v2/payments/ach/:external_id/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "external_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get the ach payment information"
        },
        {
          "info": {
            "name": "Cancel ACH Payment",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://host.com/v2/payments/ach/:external_id/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "external_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Cancel the ACH payment."
        },
        {
          "info": {
            "name": "Get All Transfers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://host.com/v2/payments/transfer/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of results to return per page."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The initial index from which to return the results."
              }
            ]
          },
          "docs": "Get transfer information"
        },
        {
          "info": {
            "name": "Create Transfer",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://host.com/v2/payments/transfer/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Xpay transfer between CRB users"
        },
        {
          "info": {
            "name": "Get Transfer",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://host.com/v2/payments/transfer/:external_id/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "external_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "A search term."
              }
            ]
          },
          "docs": "Get transfer information"
        },
        {
          "info": {
            "name": "List Get Instant Payment Responses",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://host.com/v2/payments/instant/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "A page number within the paginated result set."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Number of results to return per page."
              }
            ]
          },
          "docs": "Get the instant payment information"
        },
        {
          "info": {
            "name": "Create Create Instant Payment Request",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://host.com/v2/payments/instant/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create an Instant Payment request to move funds from an DDA to an external bank account"
        },
        {
          "info": {
            "name": "Retrieve Get Instant Payment Response",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://host.com/v2/payments/instant/:external_id/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "external_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get the instant payment information"
        },
        {
          "info": {
            "name": "List AFT Payment Requests",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://host.com/v2/payments/aft/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "A page number within the paginated result set."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Number of results to return per page."
              }
            ]
          },
          "docs": "Get a paginated list of AFT payment requests"
        },
        {
          "info": {
            "name": "Create AFT Payment Request",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://host.com/v2/payments/aft/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create an AFT (Account Funding Transaction) request to pull funds from a consumer's external payment card"
        },
        {
          "info": {
            "name": "Retrieve AFT Payment Request",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://host.com/v2/payments/aft/:id/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get the AFT payment information"
        },
        {
          "info": {
            "name": "List OCT Payment Requests",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://host.com/v2/payments/oct/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "A page number within the paginated result set."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Number of results to return per page."
              }
            ]
          },
          "docs": "Get a paginated list of OCT payment requests"
        },
        {
          "info": {
            "name": "Create OCT Payment Request",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://host.com/v2/payments/oct/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create an OCT (Original Credit Transaction) request to push funds directly to a consumer's payment card"
        },
        {
          "info": {
            "name": "Retrieve OCT Payment Request",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://host.com/v2/payments/oct/:id/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get the OCT payment information"
        },
        {
          "info": {
            "name": "List Peer To Peer Payment Responses",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://host.com/v2/payments/p2p/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "A page number within the paginated result set."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Number of results to return per page."
              }
            ]
          },
          "docs": "Returns a paginated list of all P2P payments across every consumer on the authenticated partner's network."
        },
        {
          "info": {
            "name": "Create Peer To Peer Payment Request",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://host.com/v2/payments/p2p/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Initiate a peer-to-peer transfer between two consumers on the authenticated partner's network. Both accounts must be active secured-card accounts. Returns `pending_review` instead of an error when the sender exceeds the daily velocity limit (2 transfers per 24 hours).\n"
        },
        {
          "info": {
            "name": "Retrieve Peer To Peer Payment Response",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://host.com/v2/payments/p2p/:id/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique ID of the P2P payment (returned at creation time)."
              }
            ]
          },
          "docs": "Retrieve a single P2P payment by its ID. Returns 404 for payments that do not belong to the authenticated partner.\n"
        }
      ]
    }
  ],
  "bundled": true
}