- Introduction
- Pagination
- Metadata
- Attributes Formats
- Identifiers
- Events
- Compliance Guard
- Locks
- Sync calls
- Errors
- Auth
- postCreate a short-lived token
- postExchange username and password for JWT token
- putExchange current token for a new one
- delEnd login session, invalidating current login token.
- postChange password
- getGet all permissions for the requesting user
- getGet logged-in user's info.
- postTakes a user ID and returns a temporary token that can be exchanged for a real auth token.
- postSend one time code.
- putReplace user's auth based on configured company auth type
- postSAML callback endpoint
- getRedirect to the SAML login endpoint
- getDisplay Peach SP Metadata
- getDisplay IdP setup help
- API Keys
- Auth
- Borrowers
- Identity
- Contact Information
- Payment Instruments
- Consent
- Documents
- getGet document descriptors
- postCreate new document descriptor
- getGet document descriptor by ID
- putUpdate document descriptor
- delDelete document
- postUpload document content
- getDownload document content
- postConvert document to the specified format
- postDigitally sign document
- getGet document upload links
- postCreate document upload link
- getGet doc upload link by ID
- postCreate new document via link
- postUpload document content via link
- Legal Representation
- Verifications
- Verification Types
- Cases
- getGet all cases
- getList active case escalations for a company
- postCreate borrower case
- getGet borrower cases
- getGet borrower case by ID
- putUpdate case
- postAdd association
- delRemove association
- postMark a case as viewed
- postEscalate or de-escalate a case
- getList case escalations
- getList case escalation by ID
- postSnooze case
- Case Types
- Smart Reviews
- Supercases
- postCreate supercase
- getList supercases
- getGet supercase members.csv template
- getGet supercase by ID
- putUpdate supercase
- getList populations
- getGet committed membership as CSV
- getGet draft population
- postCommit draft population
- getGet the draft population members
- putSet the draft population membership
- postAdd to the draft population membership
- getGet membership as CSV
- putSet membership with CSV
- postAdd to membership with CSV
- getGet population by ID
- putUpdate population
- getGet population membership
- getGet membership as CSV
- getGet private notes
- postCreate private note
- getGet private note by ID
- putUpdate private note
- getGet global notes
- postCreate global note
- getGet global note by ID
- putUpdate global note
- getGet the list of supercase documents
- postAssociate documents with the supercase
- putSet the documents associated with the supercase
- postUpdate all subcases
- postSend a message to the borrowers on all subcases
- postSend a message to the borrowers on all subcases of the population
- postCreate Do Not Interact instances on all subcases
- postDelete supercase related Do Not Interact instances on all subcases
- getList bulk operations on this supercase
- getSearch bulk operations on this supercase
- getGet supercase bulk operation by ID
- getGet target populations for the supercase bulk operation
- getGet member bulk operation results by operation
- getGet the number of cases associated with the supercase
- Do Not Interact
- Do Not Interact Types
- Notification Types
- Notes
- Workflows
- Workflow Types
- getGet workflow types
- postCreate workflow type
- postExport workflow, step and work item types.
- postRestore previously exported workflow, step and work item types.
- getGet workflow type by ID
- putUpdate workflow type
- delDelete workflow type
- getGet workflow step types
- postCreate workflow step type
- getGet workflow step type
- putUpdate workflow step type
- delDelete workflow step type
- getGet work item types
- postCreate work item type
- getGet work item type
- putUpdate work item type
- delDelete work item type
- Tasks
- getList Terminated Tasks
- getGet Terminated Task by ID
- postClone Terminated Task by ID
- getGet information on Twilio task queues
- putUpdate task type availability
- getGet task availability
- getList Taskrouter Workers
- getList Unterminated Tasks
- delBulk Delete Unterminated Tasks
- getRead Unterminated Task by SID
- delDeletes Unterminated Task by SID
- postAbandon Unterminated Task by SID
- Task-Worker Pairing Configs
- Cases
- Loans
- getGet loans
- postCreate loan
- getGet borrower's loans
- getGet loan by ID
- putUpdate loan
- getGet loan lock status
- postActivate loan
- postReimburse
- postCancel loan
- postClose loan
- postReopen a closed loan
- getGet loan credit limit
- postUpdate loan credit limit
- postFreeze loan
- postUnfreeze loan
- postAccelerate loan
- postReverse accelerate
- postCharge-off loan
- postReverse charge-off
- postRefresh loan
- postMigrate loan
- Installment Advances
- Installment Refunds
- Line of Credit Draws
- Line of Credit Purchases
- getGet line of credit purchases
- getGet line of credit purchases timeline
- postCreate purchase
- getGet draw purchases
- getGet draw purchases timeline
- getGet purchase by ID
- putUpdate purchase
- postCreate purchase dispute
- getGet purchase disputes
- getGet draw purchase disputes
- getGet line of credit purchase disputes
- getGet purchase dispute by ID
- putUpdate purchase dispute
- Line of Credit Migration
- postCreate past periods data
- putUpdate past period data
- delDelete past period data
- getGet past period data
- getGet migration period LOC data
- putUpdate migration period LOC data
- postCreate migration period LOC data
- getGet migration period draw data
- putUpdate migration period draw data
- postCreate migration period draw data
- postCreate past transaction
- getGet past transactions
- putUpdate past transaction
- getGet past transaction by ID
- Expected Payments
- Obligations
- Periods
- Payment Plans
- Promise to Pay Plans
- Fees
- Rates
- Transactions
- Statements
- Autopay
- Balances
- Credit Reporting
- Loan Investors
- Collection Agency
- Promo Programs
- postCreate promo program
- getGet promo programs
- getGet promo program by ID
- putUpdate promo program
- delCancel promo program
- postCreate promo program for draw
- getGet promo program for draw by ID
- putUpdate promo program for draw
- delCancel promo program for draw
- postActivate promo program
- postActivate promo program for draw
- Card
- Loan Labels
- Loans
- Communicator
- postSend message
- postReceive message
- postResend existing interaction
- postRender to download
- postRender to document
- postRender template preview for subject
- postSend free-form email
- postPreview free-form email
- postSend confirmation code for contact verification
- getList subject desciptors
- getGet subject descriptor
- putUpdate subject descriptor
- Templates
- Management
- Content
- getList template descriptors
- postCreate template descriptor
- getGet template descriptor
- putUpdate template descriptor
- delDelete template descriptor
- getList template versions for descriptor
- getList all template versions (Deprecated)
- postCreate template version
- getList all template versions (v2)
- getGet template version
- putUpdate template version
- delDelete template version
- putActivate template version
- postRender template version preview
- postRender template version
- getList context vars for template version
- getExport all template descriptors and versions
- postImport exported template descriptors and versions
- System Documents & UI
- System Sent Messages
- schemaautopayAmountChanged
- schemaautopayCanceledBySystem
- schemaautopayEnabled
- schemaautopayEnableReminder
- schemaautopayPaymentCanceled
- schemaautopayPaymentMethodUpdated
- schemaautopayPaymentReminder
- schemaautopayPaymentRescheduled
- schemacardExpiresReminder
- schemaceaseCommunicationAcknowledgement
- schemaceaseCommunicationRefuseToPay
- schemaconfirmationCode
- schemacontactTakeover
- schemacustomX
- schemadebtValidationNotice
- schemadebtValidationNoticeArizona
- schemadebtValidationNoticeAutomatic
- schemadebtValidationNoticeNYCYonkers
- schemadebtValidationNoticePuertoRico
- schemadeceasedConfirmationOfPayoff
- schemadeceasedNoticeToRepresentative
- schemadeceasedNotificationUponDeath
- schemadisputeOfDebtSubmitDocumentation
- schemadisputeOfDebtConfirmed
- schemadisputeOfDebtSubmitDocumentationReminder
- schemadisputeOfDebtUnableToConfirm
- schemadisputeOfDebtUnableToResolve
- Interactions
- postCreate interaction
- getGet borrower interactions
- getGet interaction by ID
- putUpdate interaction
- delDelete interaction
- getGet previous interactions
- getDownload interaction recording
- getDownload interaction voicemail
- getGet interaction call summaries
- getGet cases associated with an interaction
- getGet interactions
- getGet interaction by ID
- getGet previous interactions
- getGet interaction convo
- postJoin interaction convo
- postClose interaction convo
- postLeave interaction convo
- getDownload interaction recording
- getDownload interaction voicemail
- getGet interaction call summaries
- getGet previous interactions
- getGet interaction call summaries
- Compliance Guard
- Communicator
- Errors
- schemaInvalidInput
- schemaBadRequest
- schemaInvalidJSON
- schemaInvalidPublicId
- schemaUnprocessableEntity
- schemaUnauthorized
- schemaForbidden
- schemaNotFound
- schemaUrlNotDefined
- schemaTemplateDisabled
- schemaNoSuitableContact
- schemaUndefinedTemplateVariable
- schemaBadExternalServiceCredentials
- schemaTemplateSyntax
- schemaDuplicate
- schemaConfigMismatch
- schemaCompanyConfigMismatch
- schemaLoanLocked
- schemaCardLocked
- schemaInternalServerError
- schemaReadReplicaNotReady
- Errors
This utility function returns card details. The BIN information is provided by First Data and normally updated weekly.
Get BIN details from card number
Securityoauth2 or bearerAuth or apiKeyHeader
Request
Responses
200
Card Details
404
Not found
post/bin-numbers
Request samples
- Payload
application/json
{- "cardNumber": "4111111111111111"
}Response samples
- 200
- 404
application/json
{- "status": 0,
- "message": "string",
- "data": {
- "issuer": "First United Bank",
- "cardNetwork": "visa",
- "cardType": "debit",
- "lastUpdatedDate": "string"
}
}