openapi: 3.0.1 info: title: Sezzle API v2 Bearer Authentication Reports API description: This Sezzle API is for merchants who want to accept Sezzle as a payment option termsOfService: https://legal.sezzle.com version: 2.0.0 x-logo: url: https://media.sezzle.com/branding/2.0/png/Logo_WhiteWordmark_500x126.png backgroundColor: '#392558' servers: - url: https://sandbox.gateway.sezzle.com/v2 description: development server, usa, ca - url: https://gateway.sezzle.com/v2 description: production server, usa, ca security: - Bearer: [] tags: - name: Reports paths: /settlements/summaries: get: tags: - Reports summary: Settlement Summaries operationId: getSettlementSummaries parameters: - name: start-date in: query description: Start Date required: true schema: type: string format: yyyy-mm-dd - name: end-date in: query description: End Date schema: type: string format: yyyy-mm-dd - name: offset in: query description: Pagination Offset (Limit 20) schema: type: string format: int32 - name: currency-code in: query description: ISO-4217 Currency Code schema: type: string responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/Payout' '401': $ref: '#/components/responses/Unauthorized' /settlements/details/{payout_uuid}: get: tags: - Reports summary: Settlement Details operationId: getSettlementDetails parameters: - name: payout_uuid in: path description: Payout UUID required: true schema: type: string responses: '200': description: CSV file content: text/csv: schema: type: string example: 'total_order_amount,total_capture_amount,total_refund_amount,total_fee_amount,total_returned_fee_amount,total_chargeback_amount,total_chargeback_reversal_amount,total_interest_transfer_amount,total_correction_amount,total_referral_revenue_transfer_amount,total_bank_account_withdrawals,total_bank_account_withdrawal_reversals,forex_fees,net_settlement_amount,payment_uuid,settlement_currency,payout_date,payout_status,final_payout_amount,payout_currency 703.20,703.20,-5.00,-43.80,.30,0.00,0.00,-4.30,1.71,10.00,100.00,-100.00,0.00,668.61,a5c13qt1-4126-41d3-2fq8-9ca431f51431,USD,2019-11-02 00:00:00 +0000 UTC,Complete,668.61,USD type,order_capture_date,order_created_at,event_date,order_uuid,customer_order_id,external_reference_id,order_amount,amount,posting_currency,type_code,chargeback_code,sezzle_order_id ORDER,2019-11-01T19:09:50Z,2019-11-01T19:09:50Z,2019-10-22T19:09:50Z,bm99f-31vu1-kg00e-rae1g,1,12345,500.00,,USD,001,,66d78e86-fd96-4266-9217-b769c102a0a0 ORDER,2019-11-01T19:09:50Z,2019-11-01T19:09:50Z,2019-10-22T19:09:50Z,va13d-474s9-3000e-nungg,13,12346,200.00,,USD,001,,5e0d4886-8c3d-4d4e-901a-2046a06c1e0f ORDER,2019-11-01T20:00:01Z,2019-11-01T00:00:01Z,2019-11-01T00:00:01Z,as41g-4v4s9-3000e-nunh0,1,12347,1.40,,USD,001,,a2c1a142-96ad-48c9-93d2-1acaaee9f073 ORDER,2019-11-01T20:00:01Z,2019-11-01T20:00:01Z,2019-11-01T20:00:01Z,as62l-5ptqs-9g00e-pvk10,2,12348,1.80,,USD,001,,3f62dcba-f5a4-41be-ad8f-53e938b5f310 CAPTURE,2019-11-01T20:00:01Z,2019-11-01T20:00:01Z,2019-11-01T20:00:01Z,as62l-5ptqs-9g00e-pvk10,2,12348,,1.80,USD,001,,3f62dcba-f5a4-41be-ad8f-53e938b5f310 FEE,2019-11-01T19:09:50Z,2019-11-01T19:09:50Z,2019-11-01T19:09:50Z,bm99f-31vu1-kg00e-rae1g,1,12345,,-30.00,USD,003,,66d78e86-fd96-4266-9217-b769c102a0a0 FEE,2019-11-01T19:09:50Z,2019-11-01T19:09:50Z,2019-11-01T19:09:50Z,va13d-474s9-3000e-nungg,13,12346,,-12.00,USD,003,,5e0d4886-8c3d-4d4e-901a-2046a06c1e0f FEE,2019-11-01T20:00:01Z,2019-11-01T00:00:01Z,2019-11-01T20:00:01Z,as41g-4v4s9-3000e-nunh0,1,12347,,-1.20,USD,003,,a2c1a142-96ad-48c9-93d2-1acaaee9f073 FEE,2019-11-01T20:00:01Z,2019-11-01T20:00:01Z,2019-11-01T20:00:01Z,as62l-5ptqs-9g00e-pvk10,2,12348,,-0.60,USD,003,,3f62dcba-f5a4-41be-ad8f-53e938b5f310 REFUND,2019-10-22T19:09:50Z,2019-10-22T19:09:50Z,2019-11-01T19:09:50Z,bm5rm-vg2js-1tsky-c2dsky,8,12344,,5.00,USD,002,,e4194956-de70-4958-9da4-6c05f276fdab RETURNED_FEE,2019-10-22T19:09:50Z,2019-10-22T19:09:50Z,2019-11-01T19:09:50Z,bm5rm-vg2js-1tsky-c2dsky,7,12344,,.30,USD,004,,e4194956-de70-4958-9da4-6c05f276fdab CORRECTION,,,2019-11-01T17:00:01Z,,,,,-1.29,,007, CORRECTION,,,2019-11-01T17:00:01Z,,,,,3.00,,007, INTEREST_TRANSFER,,,2019-11-01T18:00:01Z,,,,,-4.30,,008, REFERRAL_REVENUE_TRANSFER,,,2019-11-01T15:00:01Z,,,,,10.00,,009, BANK_ACCOUNT_WITHDRAWAL,,,2019-11-02T00:05:00Z,,,,,100.00,,010, BANK_ACCOUNT_WITHDRAWAL_REVERSAL,,,2019-11-02T00:05:00Z,,,,,-100.00,,011, MONTHLY_FEE,,,2019-11-01T00:00:00Z,,,,,-15.00,USD,013, MONTHLY_FEE_REFUND,,,2019-11-01T00:00:00Z,,,,,15.00,USD,014, ' '401': $ref: '#/components/responses/Unauthorized' /interest/balance: get: tags: - Reports summary: Interest Account Balance operationId: getInterestAccountBalance parameters: - name: currency-code in: query description: ISO-4217 Currency Code schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object properties: interest_balance: type: number '401': $ref: '#/components/responses/Unauthorized' /interest/activity: get: tags: - Reports summary: Interest Account Activity operationId: getInterestAccountActivity parameters: - name: start-date in: query description: Start Date required: true schema: type: string format: yyyy-mm-dd - name: end-date in: query description: End Date schema: type: string format: yyyy-mm-dd - name: offset in: query description: Pagination Offset (Limit 20) schema: type: string format: int32 - name: currency-code in: query description: ISO-4217 Currency Code schema: type: string responses: '200': description: CSV file content: text/csv: schema: type: string example: 'type,event_date,interest_account_change_amount,interest_account_balance_after_change INTEREST_PAYOUT,2019-12-21T19:10:00Z,122.8718,5101.4676 INTEREST_WITHDRAWAL,2019-12-21T19:20:00Z,-26.1000,5075.3676 INTEREST_ACCRUAL,2019-12-21T19:15:00Z,1.0702,5182.3922 INTEREST_ACCRUAL,2019-12-22T19:15:00Z,1.0702,5183.4624 ' '401': $ref: '#/components/responses/Unauthorized' components: responses: Unauthorized: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error' schemas: Payout: type: array items: type: object properties: uuid: type: string payout_currency: type: string payout_date: type: string format: date-time net_settlement_amount: type: number forex_fees: type: integer status: type: string Error: type: array items: type: object properties: code: type: string location: type: string message: type: string debug_uuid: type: string securitySchemes: Bearer: type: apiKey name: Authorization in: header externalDocs: description: Sezzle API guides and tutorials url: https://docs.sezzle.com/sezzle-integration