ChargeAfter Fundings API
The Fundings API from ChargeAfter — 1 operation(s) for fundings.
OpenAPI Specification
openapi: 3.2.0
info:
title: Funding Fundings API
description: Welcome to ChargeAfter API reference! This API is implemented in a RESTful state of mind, it has straight-forward, resource-oriented endpoints, and produces standard HTTP response codes to communicate back the result of operations. To get started please contact ChargeAfter support to get your API keys, and get an access to your testing and live environments.
termsOfService: https://chargeafter.com/privacy-policy
contact:
name: Customer Support
email: support@chargeafter.com
version: 1.1.2382+7198366761a28c8d853ed62373f94bd6a1f05b4e
servers:
- url: https://api-sandbox.ca-dev.co
description: Sandbox Environment
- url: https://api.chargeafter.com
description: Production Environment
security:
- apiKey: []
tags:
- name: Fundings
paths:
/v2/post-sale/fundings/report:
get:
tags:
- Fundings
summary: GET funding report (new)
description: Return funding records based on supplied filters.
parameters:
- name: offset
in: query
description: "(Optional) The starting point of the records to be retrieved.\n \nMust be greater than or equal to 0 if supplied.\nDefault: 0"
schema:
type: integer
format: int32
example: 24000
example: 24000
- name: limit
in: query
description: "(Optional) The maximum number of records to be retrieved.\n \nMust be greater than 0 if supplied.\nDefault: 1000"
schema:
type: integer
format: int32
example: 100
example: 100
- name: fromDate
in: query
description: "(Optional) Additional limit on the funding's date.\n \nIf supplied only records with a funding date that are greater than or equal will be retrieved."
schema:
type: string
format: date-time
example: '2023-11-11'
example: '2023-11-11'
- name: toDate
in: query
description: "(Optional) Additional limit on the funding's date.\n \nIf supplied only records with a funding date that are greater than or equal will be retrieved."
schema:
type: string
format: date-time
example: '2023-11-11'
example: '2023-11-11'
- name: showMissing
in: query
description: "(Optional) Show unmatched reports\n \nIf true, display details of fundings that couldn't be matched to existing transactions."
schema:
type: boolean
example: true
example: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ChargeAfter.Postsale.WebApi.Contracts.Dtos.RecordSetDto.Of.ChargeAfter.Postsale.WebApi.Contracts.Dtos.Fundings.FundingDtoV2'
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
requestId:
type: string
example: Unique RequestId
message:
type: string
example: Message Describing The Error
'401':
description: Unauthorized
'422':
description: Input Validation Error
content:
application/json:
schema:
type: object
properties:
requestId:
type: string
message:
type: string
errors:
type: array
items:
properties:
field:
type: string
validationState:
type: string
error:
type: string
example:
RequestId: Unique RequestId
Message: Input Validation Failure
Errors:
- Field: RequestField1
ValidationState: Invalid
Error: RequestField1 should be up to 150 characters, and can contain a-z, A-Z, _ characters.
'500':
description: General Server Error
content:
application/json:
schema:
example:
requestId: Unique RequestId
errors:
- code: '1'
description: Internal unknown error occurred
components:
schemas:
ChargeAfter.Libraries.WebApi.Contracts.Responses.Offers.Models.FinancialProductType:
enum:
- LineOfCredit
- Installments
- LeaseToOwn
- MerchantSelfFinancing
type: string
? ChargeAfter.Postsale.WebApi.Contracts.Dtos.RecordSetDto.Of.ChargeAfter.Postsale.WebApi.Contracts.Dtos.Fundings.FundingDtoV2
: type: object
properties:
records:
type: array
items:
$ref: '#/components/schemas/ChargeAfter.Postsale.WebApi.Contracts.Dtos.Fundings.FundingDtoV2'
additionalProperties: false
ChargeAfter.Postsale.WebApi.Contracts.Dtos.Transactions.TransactionType:
enum:
- Authorize
- Settle
- Refund
- Void
- Chargeback
- Reversal
type: string
ChargeAfter.Postsale.WebApi.Contracts.Dtos.Fundings.FundingStatus:
enum:
- RECONCILED
- UNRECONCILED
- MISMATCHED
- TYPE_MISMATCH
- AMOUNT_MISMATCH
- ORIGINAL_TRANSACTION_MISSING
- MISSING
- CHARGEBACK
type: string
description: <p>Description:</p><ul><li><i>RECONCILED</i> - Funding report matches actual transaction.</li><li><i>UNRECONCILED</i> - Funding report does not match actual transaction. This is a legacy status.</li><li><i>MISMATCHED</i> - Funding report does not match actual transaction. This is a legacy status.</li><li><i>TYPE_MISMATCH</i> - Funding report has a different transaction type from the actual transaction.</li><li><i>AMOUNT_MISMATCH</i> - Funding report has a different transaction type from the actual transaction.</li><li><i>ORIGINAL_TRANSACTION_MISSING</i> - Funding report can't be matched to a known transaction.</li><li><i>MISSING</i> - Funding report can't be matched to a known transaction. This is a legacy status.</li><li><i>CHARGEBACK</i> - Chargeback funding report. This is a legacy status.</li></ul>
ChargeAfter.Postsale.WebApi.Contracts.Dtos.Fundings.FundingDtoV2:
required:
- discountAmount
- fundedAt
- lenderName
- netAmount
- status
- transactionAmount
- transactionType
- updatedAt
type: object
properties:
productType:
allOf:
- $ref: '#/components/schemas/ChargeAfter.Libraries.WebApi.Contracts.Responses.Offers.Models.FinancialProductType'
description: The product type of the original lender's offer for the purchase.
example: LineOfCredit
promoCode:
type: string
description: The promo code of the original lender's offer for the purchase.
example: '123'
lenderReferenceId:
type: string
description: The identifier for the transaction reported by the lender.
example: '123'
merchantTransactionId:
type: string
description: The identifier for the transaction defined by the merchant.
example: '123'
status:
allOf:
- $ref: '#/components/schemas/ChargeAfter.Postsale.WebApi.Contracts.Dtos.Fundings.FundingStatus'
description: The funding status calculated for the funding report.
example: RECONCILED
fundedAt:
type: string
description: The funding date.
format: date-time
example: '2023-11-03T00:00:00Z'
firstName:
type: string
description: First name of the consumer that performed the original order.
example: John
lastName:
type: string
description: Last name of the consumer that performed the original order.
example: Smith
updatedAt:
type: string
description: The last update date of the funding record.
format: date-time
example: '2023-11-03T00:00:00Z'
email:
type: string
description: Email of the consumer that performed the original order.
example: johnsmith@email.com
lenderName:
minLength: 1
type: string
description: The lender that reported the funding.<br /><b>Note:</b> Because this value may change, customers should not bind to this parameter. Instead, bind to the lenderId and set the lenderName in your system.
example: Finara
discountAmount:
type: number
description: The discount amount as reported by the lender.
format: double
example: 10
netAmount:
type: number
description: The net purchase amount as reported by the lender.
format: double
example: 89.99
transactionAmount:
type: number
description: The purchase amount as reported by the lender.
format: double
example: 99.99
transactionType:
allOf:
- $ref: '#/components/schemas/ChargeAfter.Postsale.WebApi.Contracts.Dtos.Transactions.TransactionType'
description: The type of the transaction associated with the reported funding.
example: Settle
transactionId:
type: string
description: The ID of the transaction associated with the reported funding.
example: 6663c0bd6c45635eaea75aaa
merchantOrderId:
type: string
description: The merchant order ID of the original order associated with the reported funding.
example: '12345'
chargeId:
type: string
description: The ID of the charge associated with the reported funding.
example: 6663c0bd6c45635eaea75aaa
transactionDate:
type:
- string
- 'null'
description: The date of the original transaction associated with the reported funding.
format: date-time
example: '2023-11-03T00:00:00Z'
additionalProperties: false
securitySchemes:
apiKey:
type: apiKey
name: Authorization
in: header